-
基础知识
-
平台操作流程
-
API接口
-
状态码
-
调用接口实例
技术服务
API接口
点对点组包短信发送接口(P2PBatch)
接口名称 点对点组包短信发送接口 接口描述 实现对不同号码发送不同短信内容(即点对点)一次性组包提交接口进行发送任务 请求地址 http://ip:port/api/sms/p2psend
或者https://ip:port/api/sms/p2psend
请求方式 POST JSON Head 头文件设置 (Key)Content-Type (value) application/json;charset=utf-8
应答方式 JSON 接口协议 HTTP 注:一次性提交最大支持 1000 个号码
输入参数
字段名称 是否必填 说明 数据类型 长度 userid 必填 用户编号,接入方信息唯一标识 String 由平台方分配 ts 必填 时间戳, 5 分钟内有效, 时间戳是指格林威治时间 1970 年 01 月 01 日 00 时 00 分00 秒起至现在的总毫秒数(精确到毫秒) Long System.curren tTimeMillis()
sign 必填 三个信息字符串拼接,然后md5 算法加密 (MD5 用 32 位,值必须要小写进行加密) md5(userid + ts + apikey)
中间无需空格无+号String apikey: 由平台方分配 extnum 选填 下发扩展号(0-12 位) String 最长 12 位 time 选填 发送时间(为空表示立即发送,如果定时发送,则需要按yyyyMMddHHmmss 格式,如:20110115105822) String yyyyMMddHH mmss messageid 选填 客户侧唯一消息ID,状态报告推送接口原样带回。不支持特殊字符‘-’ String 最长 32 位 list 必须 批量发送集合 array mobile 必填 需要发送的手机号(单个号码) String 13800000000 msgcontent 必填 短信内容 String
请求参数示例(请求体):
{
"userid": "100001 ",
"ts": "1476235100217",
"sign": "54449 bb492c2ea2592ea3eceef3d0b47",
"list": [
{
"mobile ": "18600000001 ",
"msgcontent": "【邦邦快递】 您的快递已到, 取件号: 1234"
},
{
"mobile ": "18600000002 ",
"msgcontent": "【邦邦快递】 您的快递已到, 取件号: 2345"
}
]
}
输出参数
字段名称 说明 数据类型 长度 code 状态码 String 10 msg 状态描述 String 50 data 数据节点 Object taskid 任务ID,接口返回的 taskid,如果接口返回非 0,则不返回data 节点 String 最长 32 位 result 提交结果集合 array code 具体号码提交状态码 String msg 具体号码提交状态描述 String mobile 具体提交手机号码 String
说明:taskid 是字符串格式,长度最大 32 位,code=0 时才会有data 节点和taskid 字段, 单次请求只会返回一个taskid。
返回信息示例:
返回信息说明:
返回对象code 字段等于 0 时表示全部或部分提交成功;code 不等于 0 时表示全部提交失败。result 集合为具体提交情况,result 集合元素中code 等于 0 表示提交成功,不等于 0 则表示提交失败。
成功返回示例:
{
"code": "0",
"msg": "成功", "data": {
"taskid": "T1011220639000170512059",
"result": [{
"mobile": "18600000001",
"code": "0",
"msg": "提交成功"
},
{
"mobile": "18600000002",
"code": "11",
"msg": "短信内容过长"
}
]
}
}
失败返回示例(签名信息鉴权失败时,其他错误信息类似):
{
"code": "6",
"msg": "sign 校验失败", "data": {
"taskid": "",
"result": [{
"mobile": "18600000001",
"code": "6",
"msg": "sign 校验失败"
},
{
"mobile": "18600000002",
"code": "6",
"msg": "sign 校验失败"
}
]
}
}
模拟测试环境接口
短信平台可为客户提供模拟测试环境短信接口,通过测试环境可达到,短信不实际下发可实时监测双方平台的连接和处理能力。具体包括:
支持下发短信的链路测试
支持短信状态报告测试
支持下发短信压力测试
进行内部逻辑相关测试
不支持上行短信的测试