1. 引言
本文档主要提供短信平台对用户开放的主要接口和定义说明。
2. 短信接口
注:终端客户的接入方式设置为http接入时才能使用此接口。
以下http://xxx/msg/send/json 或者https://xxx/msg/send/json请求地址不完整, 请登录253云通讯自助通平台或者询问您的商务负责人获取。
该接口数据请求和响应返回均采用json格式封装的字符串,编码(对整个请求的字符串编码)统一为UTF-8,采用post方式提交请求。
2.1 短信下发
名称 |
说明 |
协议 |
HTTP |
提交方式 |
只支持POST |
编码格式 |
UTF-8 |
Content-Type |
application/json |
http地址 |
http://xxx/msg/send/json |
https地址(更安全) |
https://xxx/msg/send/json |
说明 |
此接口可以提交不超过50000个手机号码,每个号码用英文逗号间隔。 |
请求说明 |
以下json内容为提交请求格式: {"account":"N6000001", "password":"123456", "msg":"【253】您的验证码是:2530", "phone":"15800000000", "sendtime":"201704101400", "report":"true", "extend":"555", "uid":"321abc" } 字段说明 account:用户账号,必填 password:用户密码,必填 msg:短信内容。长度不能超过536个字符,必填 phone:手机号码。多个手机号码使用英文逗号分隔,必填 sendtime:定时发送短信时间。格式为yyyyMMddHHmm,值小于或等于当前时间则立即发送,默认立即发送,选填 report:是否需要状态报告(默认false),选填 extend:下发短信号码扩展码,纯数字,建议1-3位,选填 uid:该条短信在您业务系统内的ID,如订单号或者短信发送记录流水号,选填 |
响应说明 |
该响应为提交响应,发送到手机是否成功请获取状态报告确认 响应数据格式: {"time":"20170410103836", "msgId":"17041010383624511", "errorMsg":"", "code":"0" } 字段说明: time:响应时间 msgId:消息id errorMsg:状态码说明(成功返回空) code:状态码(详细参考提交响应状态码)
|
2.2 变量短信
名称 |
说明 |
协议 |
HTTP |
提交方式 |