手把手教你如何開發融雲短信服務

概述

爲滿足應用中短信驗證業務需求,融雲與優質短信平臺合作,提供具有全網覆蓋能力的短信驗證碼發送、驗證功能接口,詳細開通及使用說明如下:

短信功能使用流程

開發者在使用短信驗證功能前,需前往融雲官方網站註冊創建融雲開發者帳號。
這裏寫圖片描述
使用流程

短信服務使用說明

認證企業開發者

在融雲開發者後臺,選擇需要開通短信功能的應用,進入應用詳情頁面,點擊 “短信服務 > 服務設置” 進行企業認證,提交認證信息後,會在 5 個工作日內審覈完成。
認真企業開發者
認證企業開發者

短信資費、扣費說明

認證成功後,需要充值購買短信才能使用短信服務,短信價格如下:

充值爲 100 的整數倍 例如:100, 200, 1100, 1200…

充值金額 < 1000 元時,短信單價爲 0.060 元/條
1000 ≤ 充值金額 < 5000 元時,短信單價爲 0.055 元/條
充值金額 ≥ 5000 元時,短信單價爲 0.050 元/條
短信扣費說明:

金額充值成功後,實時兌換成相應短信條數。
短信條數將在短信發送後 48 小時內完成扣除,短信實際扣除條數以運營商結算爲準。
長短信扣費規則:
短信總字數 ≤ 70 個字時,算一條。
短信總字數 > 70 個字時,應扣條數 = 短信總字數 / 67,向上取整。例如 134 個字的短信將按兩條扣費, 71 個字的短信,也將按 2 條扣費。
短信中的字母、數字、符號、空格都算一個字。

短信簽名

每條短信都必須帶有簽名,可以在開發者後臺 “短信服務 > 服務設置” 中進行添加。

簽名說明

根據中國基礎運營商的相關規定,每條短信的最後必須包含簽名,如果沒有簽名,則短信肯定無法正常發送。
簽名格式爲中文括號加公司簡稱或者店鋪名稱等:例如:【融雲即時通訊雲】,建議使用 3-7 個漢字。
可以包含數字、漢字、英文,不能爲純數字、純英文或數字+英文的組合,不能包含其他特殊符號。
簽名會自動附加,因此會佔用短信的字數,請注意控制內容長度。

圖片驗證

開發者可選擇開啓或關閉圖片驗證功能,開啓後可通過 獲取圖驗接口 獲取圖驗 URL 地址,在發送短信驗證碼時會對圖驗進行驗證,驗證通過纔會下發短信驗證碼,否則不會下發短信驗證碼,防止短信騷擾。

短信模板

融雲默認爲提供用戶註冊、密碼找回、修改密碼、身份驗證、通用驗證碼等 5 個短信模板,如果用戶有新的模板需求,可提交模板申請添加。

需要說明模板名稱、短信用途及內容,短信內容中需要標出簽名位置(只能在短信內容前面或最後)及驗證碼位置。

短信號碼

短信號碼說明

短信號碼在每創建一個應用後,系統會自動分配一個短信端口號碼。
因受政策限制,已分配的短信端口號碼某些時候不可用。
暫不提供自定義短信號碼。

獲取圖片驗證碼方法

開發者後臺開通圖片驗證功能後,才能獲取圖片驗證碼。

示例

HTTP 請求方式: GET

http://api.sms.ronghub.com/getImgCode.json?appKey=uwd1c0sxdlx2
表單參數

名稱 類型 說明
appKey String 應用 AppKey。(必傳)
返回值

名稱 類型 說明
code int 返回碼,200 爲正常。
url String 返回的圖片驗證碼 URL 地址。
verifyId String 返回圖片驗證標識 Id。
json格式:

{
“code”: 200,
“url”: “xxxxxxxxxxxxx”,
“verifyId”: “xxxxxxxx”
}

發送短信驗證碼方法

方法名:/sendCode

簽名方法:請參考 通用 API 接口簽名規則

URL:http://api.sms.ronghub.com/sendCode.json

HTTP 方法:POST

示例

HTTP 請求:

POST /sendCode.json HTTP/1.1
Host: api.sms.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408706337
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded

mobile=13500000000&verifyId=1408706337&verifyCode=890b422b&templateId=dsfdsfd&region=86
表單參數

名稱 類型 說明
mobile String 接收短信驗證碼的目標手機號,每分鐘同一手機號只能發送一次短信驗證碼。(必傳)
verifyId String 圖片驗證標識 Id ,開啓圖片驗證功能後此參數必傳,否則可以不傳。在獲取圖片驗證碼方法返回值中獲取。
verifyCode String 圖片驗證碼,開啓圖片驗證功能後此參數必傳,否則可以不傳。
templateId String 短信模板 Id,在“開發者後臺->短信服務->服務設置->短信模版”中獲取。(必傳)
region String 手機號碼所屬國家區號,目前只支持中國區號 86(必傳)
返回值

名稱 類型 說明
code int 返回碼,200 爲正常。
sessionId String 短信驗證碼唯一標識。
json格式:

{
“code”: 200,
“sessionId”: “xxxxxxx”
}
注:每分鐘同一手機號只能發送一次短信驗證碼,短信驗證碼有效期爲 15 分鐘,短信驗證成功後驗證碼失效。開通圖片驗證功能後,如果此條圖片驗證不成功則用戶不會收到驗證短信。
返回值請參考 API 方法返回值說明

驗證碼驗證方法

方法名:/verifyCode

簽名方法:請參考 通用 API 接口簽名規則

URL:http://api.sms.ronghub.com/verifyCode.json

HTTP 方法:POST

示例

HTTP 請求:

POST /verifyCode.json HTTP/1.1
Host: api.sms.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408706337
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded

sessionId=2312312&code=3122
表單參數

名稱 類型 說明
sessionId String 短信驗證碼唯一標識,在發送短信驗證碼方法,返回值中獲取。(必傳)
code String 短信驗證碼內容。(必傳)
返回值

名稱 類型 說明
code int 返回碼,200 爲正常。
success Boolean true 驗證成功,false 驗證失敗。
json格式:

{“code”:200,”success”:true}
返回值請參考 API 方法返回值說明

發送通知類短信方法

方法名:/sendNotify

簽名方法:請參考 通用 API 接口簽名規則

URL:http://api.sms.ronghub.com/sendNotify.json

HTTP 方法:POST

示例

HTTP 請求:

POST /sendNotify.json HTTP/1.1
Host: api.sms.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408706337
Signature: 890b422b75c1c5cb706e4f7921df1d94e69c17f4
Content-Type: application/x-www-form-urlencoded

mobile=13500000000&templateId=dsfdsfd&region=86&p1=aa&p2=bb&p3=cc
表單參數

名稱 類型 說明
mobile String 接收通知短信的目標手機號。(必傳)
templateId String 短信模板 Id,在“開發者後臺->短信服務->服務設置->短信模版”中獲取。(必傳)
region String 手機號碼所屬國家區號,目前只支持中國區號 86(必傳)
p1 String 短信模板中,自定義變量值,如果在通知短信模板中定義了 {p1} 則在發送通知短信時必須傳入此參數,替換模板中的 {p1},否則此參數可以不傳。
p2 String 短信模板中,自定義變量值,如果在通知短信模板中定義了 {p2} 則在發送通知短信時必須傳入此參數,替換模板中的 {p2},否則此參數可以不傳。
p3 String 短信模板中,自定義變量值,如果在通知短信模板中定義了 {p3} 則在發送通知短信時必須傳入此參數,替換模板中的 {p3},否則此參數可以不傳。
注:發送的所有短信內容(包括短信通知和短信驗證碼)不能超過 210 個字。

返回值
名稱 類型 說明
code int 返回碼,200 爲正常。
sessionId String 短信唯一標識。

json格式:
{
“code”: 200,
“sessionId”: “xxxxxxx”
}
返回值請參考 API 方法返回值說明

API 方法返回值說明

code 描述 HTTP 狀態碼
1009 沒有開啓圖驗功能 400
1010 未使用已開啓的圖驗功能 400
1000 內部邏輯錯誤 500
1003 參數錯誤 400
1005 參數長度超出限制 400
1008 調用超過頻率上限 429
1002 缺少參數 400
1004 驗證簽名錯誤 401
1050 內部服務響應超時 504
1012 圖片驗證碼不正確 430
1011 剩餘條數不足,需要充值 430
1013 短信通道不可用 430
1014 短信驗證碼已驗證過,再次驗證失效 430
1015 短信驗證碼過期無效 430

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章