最近更新时间:2023-05-08
接口地址:http://103.131.171.81:9090/sms/batch/v1
请求方法:POST
接口描述:用于请求短信业务平台向指定用户发送短信。
请求头里面需要设置传输格式:Content-type:application/json
参数名称 | 描述 | 是否必须 | 备注 |
appkey | 应用key | 是 | 参见“公共参数说明” |
appcode | 应用代码 | 是 | 参见“公共参数说明” |
templateCode | 短信模板标识 | 否 | 短信内容模板唯一标识,使用接口发送短信时可使用该参数来标识一个短信内容模板,而不用输入整个短信内容 |
templateParma | 短信模板参数 | templateCode参数不为空时,若短信模板存在变量,则该参数必传;若短信模板不存在变量,该参数不设置。 数据格式为JSON字符串 | |
msg | 下发的短信内容 | templateCode为空时,该参数必传。 短信内容长度不超过1000个字(包括1000字),每个英文或阿拉伯字符算1个字。 短信模板审核通过后才能进行发送 | |
phone | 手机号码 | 是 | 多个号码用半角英文逗号隔开,一次最多不能超过1000个 |
timestamp | 时间戳 | 是 | 时间戳(精确到毫秒),当前时间5分钟内请求有效 |
sign | 签名验证MD5 | 是 | appkey+appsecret+timestamp经过md5加密后的32位16进制小写字符串(拼接过程不包括+) |
uid | String | 否 | 唯一标识(32位字符串以内,用于获取短信回执,不传或者传空字符串系统自动生成32位字符串) |
extend | 拓展号 | 否 | 该参数是显示在接收手机上的主叫尾号,可用于上行信息匹配,如:001,119等。通道本身主叫号加上用户自己分配扩展号的总长度不能超过20位 |
请求参数信息说明:
示例一:
{ "sign": "de7cb2fb99756c06214fc78252d36484", "timestamp": "1520496753938", "phone": "15100000055,15100000044", "extend": "123", "appcode": "test", "appkey": "test", "msg": "你好,测试" } |
示例二:
{ "sign": "de7cb2fb99756c06214fc78252d36484", "timestamp": "1520496753938", "phone": "15100000055,15100000044", "extend": "123", "appcode": "test", "appkey": "test", "templateCode": "IX2VpYGG", "templateParma": "{\"user\":\"张三\",\"code\":\"265485\"}" } |
参数名称 | 类型 | 描述 |
code | String | 返回码 |
desc | String | 返回码描述 |
uid | String | 提交返回的唯一标识(32位字符串,用于获取短信回执) |
result | JSON数组 | 提交短信的详细状态数据 |
下表为result参数中的详细信息:
参数名称 | 类型 | 描述 |
status | String | 状态码 |
desc | String | 状态码描述 |
phone | String | 手机号码 |
请求成功响应信息示例如下。
{ "code": "00000", "desc": "提交成功", "uid": "8b159b0036d0402e93b39fee102eedf2", "result": [ { "status": "00000", "phone": "15100000055", "desc": "提交成功" }, { "status": "00000", "phone": "15100000044", "desc": "提交成功" } ] } |