ITPub博客

首页 > 应用开发 > IT综合 > 文字短信接口对接示例

文字短信接口对接示例

原创 IT综合 作者:乐讯通云通信 时间:2024-01-17 10:32:32 0 删除 编辑

文字短信接口介绍:

乐讯通云通信高效稳定后台服务支撑,采用多线路分流下发短信模式。三网合一共享短信网关。 接口采用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/ ,如需转载,请注明出处,否则将追究法律责任。

上一篇: 没有了~
请登录后发表评论 登录
全部评论

注册时间:2024-01-16

  • 博文量
    4
  • 访问量
    2913