-
基础知识
-
平台操作流程
-
API接口
-
状态码
-
调用接口实例
技术服务
API接口
短信发送接口(MT)
接口名称 | 短信发送接口 |
---|---|
接口描述 | 处理短信发送(支持普通短信、长短信) |
请求内容 | INDEX:http://ip:port/api/sms/send 或者 https://ip:port/api/sms/send BODY: userid=用户编号&ts=1476235100217&sign=md5(userid + ts + apikey)&mobile= 发送的手机号&msgcontent=短信内容&time=发送时间&extnum=下发扩展号 完整 URL 实例,如: http://ip:port/api/sms/send?userid=100001&ts=1476235100217&sign=54449bb492c2ea2592ea3eceef3d0b47&mobile=13800000000,135000000&msgcontent=hello&time=20110115105822&extnum=1001 |
请求方式 | POST 或 GET(群发短信建议使用 POST 方式) |
应答方式 | JSON |
接口协议 | HTTP |
输入参数
字段名称 | 是否必填 | 说明 | 数据类型 | 长度 |
---|---|---|---|---|
userid | 必填 | 用户编号,接入方信息唯一标识 | String | 由平台方分配 |
ts | 必填 | 时间戳, 5 分钟内有效, 时间戳是指格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒起至现在的总毫秒数(精确到毫秒) | Long | System.curren tTimeMillis() |
sign | 必填 | 三个信息字符串拼接,然后md5 算法加密(MD5 用 32 位,值必须要小写进行加密) md5(userid + ts + apikey) 中间无需空格、无需+号 | String | apikey: 由平台方分配 |
mobile | 必填 | 需要发送的手机号(多个号码以英文逗号 “,” 分隔) 一次性最多 1000 个号码 | String | 13800000000,135000000,136000000 |
msgconte nt | 必填 | 短信内容 需要用urlencoder 的utf-8 编码示 例 : java: URLEncode.encode(content,“utf-8”) | String | 普通短信 70字,长短信最大支持 1000 字 |
extnum | 选填 | 下发扩展号(0-12 位) | String | 最长 12 位 |
time | 选填 | 发送时间(为空表示立即发送,如果定时发送, 则需要按yyyyMMddHHmmss 格式,如: 20110115105822) | String | yyyyMMddHH mmss |
messagei d | 选填 | 客户侧唯一消息ID,状态报告推送接口原样带回。不支持特殊字符‘-’ | String | 最长 32 位 |
输出参数
字段名称 | 说明 | 数据类型 | 长度 |
---|---|---|---|
code | 状态码 | String | 10 |
msg | 状态描述 | String | 50 |
data | 数据节点 | Object | |
taskid | 任务ID,接口返回的 taskid,如果接口返回非 0,则不返回 data 节点 | String | 最长 32 位 |
参数示例:
描述:taskid 是字符串格式,长度最大 32 位,code=0 时才会有data 节点和taskid 字段, 单次请求只会返回一个taskid。
成功返回示例:
{
"code": "0",
"msg": "成功",
"data": {
"taskid": "T1011220639000170512059"
}
}
失败返回示例:
签名信息鉴权
{
"code": "11",
"msg": "签名信息鉴权失败"
}
含敏感词:
{
"code": "10",
"msg": "发送内容包含敏感词[枪支]"
}