文字簡訊介面對接示例

樂訊通雲通訊發表於2024-01-17

文字簡訊介面介紹:

樂訊通雲通訊高效穩定後臺服務支撐,採用多線路分流下發簡訊模式。三網合一共享簡訊閘道器。 介面採用http 協議,透過POST 方式提交簡訊,獲取回覆報告、狀態報告。 介面響應報文支援JSON和XML格式。 介面報文編碼支援UTF-8和GBK編碼,不同編碼請求介面地址不同。

文字簡訊介面對接示例:


請求協議:http

請求方式:採用post方式提交請求

請求報文

action=sendtemplate&username=zhangsan&password=E10ADC3949BA59ABBE56E057F20F883E&token=894gbhy&templateid=638fgths&param=手機號1|引數1|引數2@手機號2|引數1|引數2&rece=json&timestamp=636949832321055780&sign=96E79218965EB72C92A54

如果模板內容存在引數則每個手機號返回一個taskID,反之返回一個taskID

引數說明

引數名稱 是否必須 描述 示例
action 操作型別 (固定值)action=sendtemplate
username 賬戶名 username=zhangsan
password 賬戶密碼, 密碼必須MD5加密並且取32位大寫 password=E10ADC3949BA59ABBE56E057F20F883E
token 產品總覽頁面對應產品的Token token=894gbhy
templateid 模板管理報備的模板ID templateid=638fgths
param 傳送引數,可傳送一個或多個手機號,建議單次提交最多5000個號碼 17712345678|張三|2541@13825254141|李四|2536
dstime 設定要傳送簡訊的時間,精確到秒(yyyy-MM-dd HH:mm:ss) 2017-01-05 16:23:23
rece 返回型別json、xml,預設(json) rece=json
timestamp 時間戳, 13位時間戳,單位(毫秒) timestamp=636949832321055780
sign 簽名校驗 sign=96E79218965EB72C92A54


param引數詳細說明

傳送一個手機號模板為【手機號1|引數1|引數2】

傳送多個手機號模板為【手機號1|引數1|引數2@手機號2|引數3|引數4@......】

第一列必須為手機號,引數1,引數2對應簡訊模板裡的引數順序,英文豎線隔開, 比如簡訊模板為【簽名】您好,{s6},您的驗證碼是:{s6},引數1就對應您好後邊的{s6},引數2對應驗證碼是後邊的{s6}, 多個手機號以@隔開

若模板內沒有引數則只輸入手機號即可

sign引數詳細說明

簽名由引數action,username,password,token,timestamp進行MD5加密組成

比如這些值拼接後為action=sendtemplate&username=zhangsan&password=E10ADC3949BA59ABBE56E057F20F883E&token=588aaaaa&timestamp=636949832321055780,那麼就MD5加密這個引數字串得到結果後作為sign的值sign=96E79218965EB72C92A54

響應報文

引數名稱 描述 示例
returnstatus 響應狀態 "returnstatus":"success"
code 響應返回碼 "code":"0"
taskID 任務ID,帶引數任務每個手機號生成一個任務ID,不帶引數任務只返回一個任務ID {"tel_17733865073":"15913494519502337"}
remark 響應錯誤返回說明 "remark":"訪問超時!"

JSON成功返回示例

模板帶引數返回
{
    "returnstatus":"success",
    "code":"0",
    "taskID":[
        {
            "tel_17712345678":"15913494519502337"
        }
    ]
}
模板不帶引數返回
{
    "returnstatus":"success",
    "code":"0",
    "taskID":"15913523557540ece"
}

JSON失敗返回示例

{
    "returnstatus":"error",
    "code":"-51",
    "remark":"訪問超時!"
}

XML成功返回示例

模板帶引數返回
<?xml version="1.0" encoding="utf-8"?><returnsms>
  <returnstatus>success</returnstatus>
  <code>0</code>
  <taskIDs>
    <taskID>
      <tel_17712345678>1591350836530dcf1</tel_17712345678>
    </taskID>
  </taskIDs>
</returnsms>
模板不帶引數返回
<?xml version="1.0" encoding="utf-8"?><returnsms>
  <returnstatus>success</returnstatus>
  <code>0</code>
  <taskID>159135251631739ef</taskID>
</returnsms>

XML失敗返回示例

<?xml version="1.0" encoding="gb2312"?><returnsms>
  <returnstatus>error</returnstatus>
  <code>-51</code>
  <remark>訪問超時!</remark>
</returnsms>


來自 “ ITPUB部落格 ” ,連結:https://blog.itpub.net/70036589/viewspace-3004168/,如需轉載,請註明出處,否則將追究法律責任。

相關文章