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 秒起至现在的总毫秒数(精确到毫秒)LongSystem.curren tTimeMillis()
sign必填三个信息字符串拼接,然后md5 算法加密 (MD5 用 32 位,值必须要小写进行加密)md5(userid + ts + apikey) 中间无需空格无+号Stringapikey: 由平台方分配
extnum选填下发扩展号(0-12 位)String最长 12 位
time选填发送时间(为空表示立即发送,如果定时发送,则需要按yyyyMMddHHmmss 格式,如:20110115105822)StringyyyyMMddHH mmss
messageid选填客户侧唯一消息ID,状态报告推送接口原样带回。不支持特殊字符‘-’String最长 32 位
list必须批量发送集合array
mobile必填需要发送的手机号(单个号码)String13800000000
msgcontent必填短信内容String

请求参数示例(请求体):

{
"userid": "100001 ",
"ts": "1476235100217",
"sign": "54449 bb492c2ea2592ea3eceef3d0b47",
"list": [
{
"mobile ": "18600000001 ",
"msgcontent": "【邦邦快递】 您的快递已到, 取件号: 1234"
},
{
"mobile ": "18600000002 ",
"msgcontent": "【邦邦快递】 您的快递已到, 取件号: 2345"
}
]
}

输出参数

字段名称说明数据类型长度
code状态码String10
msg状态描述String50
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 校验失败"

}

]

}

}

模拟测试环境接口

短信平台可为客户提供模拟测试环境短信接口,通过测试环境可达到,短信不实际下发可实时监测双方平台的连接和处理能力。具体包括:

  • 支持下发短信的链路测试

  • 支持短信状态报告测试

  • 支持下发短信压力测试

  • 进行内部逻辑相关测试

  • 不支持上行短信的测试

您需要的服务

满足用户的不同需求,高效、稳定、灵活。亦可随时随地登录网页,在线编辑发送。

沟通合作

立即咨询

4001-077-896