短信下发
提交方式:
支持https
只支持POST,该接口数据输入输出均采用json格式封装的字符串,编码(对整个请求的字符串编码)统一为UTF-8,采用post方式提交请求。
功能:
发送不同内容短信
请求参数:
参数值说明:以下json内容为提交请求数据格式
{
"account":"dh****",
"password":"0243614f784a8cfa94a94b85cbee7540",
"data":[{
"msgid":"93786e387cf6462b9b60a36f8e7f1b27",
"phones":"11111111,1571166****,173878****,44554545",
"content":"您好!你有一个快递,请注意查收。",
"sign":"【客户签名1】",
"subcode":"",
"sendtime":""
},
{
"msgid":"93786e387cf6462b9b60a36f8e7f1b28",
"phones":"1571161****",
"content":"您的订单今日送达,谢谢",
"sign":"【客户签名2】",
"subcode":"",
"sendtime":""
}]
}
参数名 | 必要性 | 说明 |
---|---|---|
data | 必填 | 短信数集合,最多1000个 |
account | 必填 | 用户账号 |
password | 必填 | 密码,需采用MD5加密(32位小写) |
msgid | 选填 | 该批短信编号,需保证唯一,最长可填64位UUID |
phones | 必填 | 接收手机号码,多个手机号码用英文逗号分隔,最多500个,国际号码格式为+国别号手机号,号码示例如:+85255441234,注意:1)国际手机号前如果带0会去0后下发 2)发送前账号需要开通国际功能 |
content | 必填 | 短信内容,最多1000个汉字,内容中不要出现【】[]这两种方括号,该字符为签名专用 |
sign | 选填 | 短信签名,该签名需要提前报备,生效后方可使用,不可修改,不填使用默认签名,示例如:【大汉三通】 |
subcode | 选填 | 短信签名对应子码(大汉三通提供)+自定义扩展子码(选填),必须是数字,未填使用签名对应子码,无法前匹配签名对应子码则使用签名对应子码+所填子码,通常建议不填 |
sendtime | 选填 | 定时发送时间,格式yyyyMMddHHmm,为空或早于当前时间则立即发送,定时时间不能超过1个月 |
params | 选填 | 终端客户自定义参数params(总长度限制为1000),参数类型为Map,如果携带此参数会在状态报告里返回,不能作为模板变量使用,示例:"params":{"param1":"aaa","param2":"bbb"}(param1的位置如果写ctcTheme的话,ctcTheme的值会额外作为短信主题统计在大汉平台的短信主题统计里) |
urlReplace | 选填 | 是否支持长链接替换下发(该参数和账号密码同级不要放在data里),填true时内容中查找符合规则(以http或https或ftp或weixin://开头,长度大于14位且长链接两头有空格或\t或换行)的第一个长链接进行替换(一个号码对应一个短链接)后下发。(若短信内容存在多个url地址,将会以第一个url替换) 备注:如果urlReplace为true,返回响应date里会返回数据,根据提交的对象数量也会有多组对象,例如:{“result”:”0”,”desc”:”提交成功”,”data”:[{“msgid”:”11”,”status”:””,”desc”:””,”failPhones”:””,”taskid”:”17f344337ec242f393bcaae7b50b8f7a”},{“msgid”:”22”,”status”:””,”desc”:””,”failPhones”:””,”taskid”:”17f344337ec242f393bcaae7b50b8f7b”}} |
callbackurl | 选填 | 个性回调地址,该条短信的状态报告会推送到该回调地址(该参数和账号密码同级不要放在data里),注意:1)使用该参数需提前在客户服务群告知使用账号,我司需对账号配置方生效。2)回调地址固定的客户不需要使用此参数,可以直接根据推送接口进行对接 3)可以配置默认推送地址,不带callbackurl的情况下使用默认地址推送 |
moCallbackUrl | 选填 | 个性回调地址,该条短信的上行会推送到该回调地址(该参数和账号密码同级不要放在data里),注意:1)使用该参数需提前在客户服务群告知使用账号,我司需对账号配置方生效。2)回调地址固定的客户不需要使用此参数,可以直接根据推送接口进行对接 3)可以配置默认推送地址,不带moCallbackUrl的情况下使用默认地址推送 |
该响应为提交响应,发送到手机是否成功请获取状态报告确认
返回示例:
{
"result":"0",
"desc":"提交成功",
"data":[{
"msgid":"93786e387cf6462b9b60a36f8e7f1b27",
"status":"4",
"desc":"错误号码/限制运营商号码",
"failPhones":"44554545,173878****,11111111"
}]
}
只有提交失败的号码才在data里返回(urlReplace为true除外),否则data为空
返回参数说明:
参数名 | 说明 |
---|---|
desc | 状态描述 |
msgid | 该批短信编号 |
result | 该批短信提交结果;说明请参照:提交响应错误码 |
failPhones | 如果提交的号码中含有错误(格式)号码将在此显示 |
taskid | 有长链接地址替换时返回该参数,短链接的任务编号 |
Postman 请求示例截图
文档更新时间: 2024-08-28 08:29 作者:夏亮