接口说明
短信接入注意事项:
1. API账号、密码参数由我方统一提供
2. 如需推送状态报告,请提供回调地址给我方运营人员绑定(群发接口目前不支持状态推送)
3. 仅支持HTTP POST请求方式
4. 编码统一使用UTF-8
5. 请求头Content-Type必须根据接口要求设置正确,否则可能会导致参数传递错误
6. 短信内容签名没有强制要求,部分国家可为空,具体请咨询运营人员
7. 手机号码格式为区号+真实手机号码,比如中国区号为86,示例:8618888888888
253云通讯国际短信API
1 短信下发
1.1 协议说明
名称 | 说明 |
---|---|
协议 | HTTP POST |
编码格式 | UTF8 |
Content-Type | application/json |
URL | http://intapi.253.com/send/json |
1.2 请求包体
包体为json字符串,参数如下:
{
"account" : "N6000001", //API账号,50位以内。必填
"password" : "12345678", //API账号对应密钥,联系客服获取。必填
"msg" : "【253】您的验证码是:2530", //短信内容。长度不能超过536个字符。必填
"mobile" : "8615800000000" //手机号码,格式(区号+手机号码),例如:8615800000000,其中86为中国的区号,区号前不使用00开头,15800000000为接收短信的真实手机号码。5-20位。必填
}
1.3 应答包体
该响应为提交响应,发送到手机是否成功请获取状态报告确认
{
"code" : "0", //状态码
"msgid" : "17041010383624511", //消息id
"error" : "", //状态码说明(成功返回空字符串,失败返回如:余额不足)
}
注:code为响应状态码,可参照提交响应状态码对比
2 查询余额
2.1 协议说明
名称 | 说明 |
---|---|
协议 | HTTP POST |
编码格式 | UTF8 |
Content-Type | application/json |
URL | http://intapi.253.com/balance/json |
2.2 请求包体
包体为json字符串,参数如下:
{
"account" : "N6000001", //API账号,50位以内。必填
"password" : "12345678", //API账号对应密钥,联系客服获取。必填
}
2.3 应答包体
该响应为提交响应,发送到手机是否成功请获取状态报告确认
{
"code" : "0", //状态码
"error" : "", //状态码说明(成功返回空字符串)
"balance" : "7.298", //剩余可用余额,保留三位小数点
}
注:code为响应状态码,可参照提交响应状态码对比
3 回调状态
3.1 协议说明
名称 | 说明 |
---|---|
协议 | HTTP GET |
编码格式 | UTF8 |
Content-Type | application/x-www-form-urlencoded |
pushUrl | 此地址客户提供,提供给运营绑定,一个账号一个地址 |
3.2 回调示例
http://pushUrl?receiver=admin&pswd=12345&msgid=12345&reportTime=1012241002&mobile=13900210021&status=DELIVRD
参数说明如下:
receiver:接收状态报告验证的用户名(不是账户名),是按照用户要求配置的名称,默认为空
pswd:接收状态报告验证的密码,默认为空
msgid:提交短信时平台返回的msgid
reportTime:网关平台返回的时间,网关不同,格式有偏差,以具体返回格式为准。
mobile:提交短信时的手机号码
status:状态报告状态码
注:
- 成功接收请响应字符串:OK
- status 为状态报告状态码,可参照状态报告状态码对比
状态码
提交响应状态码
状态码 | 说明 |
---|---|
0 | 提交成功 |
101 | 账号不存在 |
102 | 密码错误 |
106 | 短信内容长度错误(>536) |
108 | 手机号码格式错误(>20或<5) |
110 | 余额不足 |
112 | 产品配置错误 |
114 | 请求ip和绑定ip不一致 |
115 | 没有开通国内短信权限 |
123 | 短信内容不能为空 |
128 | 账号长度错误(>50或<=0) |
状态报告状态码
状态码 | 说明 |
---|---|
DELIVRD | 短信发送成功 |
UNKNOWN | 未知短信状态 |
REJECTD | 短信被短信中心拒绝 |
MBBLACK | 目的号码是黑名单号码 |
SM11 | 网关验证号码格式错误 |
SM12 | 我方验证号码格式错误 |
其他 | 网关内部状态 |