国际短信业务接口

1 概述

1.1 Base URL

1.2 业务URL

1.3 HTTP标准包头字段

2 发送国际短信接口

2.1 请求地址

2.2 请求包体

 POST /v2/account/abcdefghijklmnopqrstuvwxyz012345/international/send?sig=C1F20E7A9733CE94F680C70A1DBABCD HTTP/1.1


 Host:192.168.0.1:8883
 content-length: 139
 Accept:application/json; 
 Content-Type:application/json;charset=utf-8; 
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
{"appId":"8c71b15cbc0444ac92fcecfcfb1e21c2","content":"Your verification code is 1234","mobile":"008613800138000,15832a","reqId":"abc"}         

2.3 响应包体

• 此步响应只表明接口请求成功，不代表短信已送达手机。具体送达状态请参考“状态报告”接口
• 对响应解析后，statusCode为"000000"表示请求发送成功。statusCode非"000000"表示请求发送失败，客户服务端可以根据自己的逻辑进行重发或者其他处理。

 HTTP/1.1 200 OK 
 Content-Length: 641
 
{
   "statusCode": "000000",
   "statusMsg": "成功",
   "msgId": "b29e2a4043b042bcb4a001eda3d952d4",
   "failList": [{
          "mobile": "15832a",
          "errorCode": "160088",
          "errorMsg": "号码格式无效"
        }]
}   

3 国际短信状态报告回调接口

• 目前支持 HTTP/HTTPS 方式的回调，采用 POST 方式，正文部分为 XML或者 JSON 格式，字符集为 UTF-8；
• 状态报告回调功能开启与回调地址的配置，请联系商务经理或售后客服配置

3.1 回调地址

3.2 回调请求参数

POST http://{ip|域名}:{port}/{path}
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request>
 <action>SMSArrived</action>
 <smsType>1</smsType>
 <recvTime>20130923010101</recvTime>
 <apiVersion>2013-12-26</apiVersion>
 <fromNum>008613800138000</fromNum>
 <deliverCode>DELIVRD</deliverCode>
 <content>4121908f3d1b4edb9210f0eb4742f62c</content>
 <reqId>123</reqId>
 <status>0</status>
 <smsCount>1</smsCount>
 <dateSent>20130923010000</dateSent>
 <spCode></spCode>
</Request>          

POST http://{ip|域名}:{port}/{path}
 
{
 "Request": {
   "action": "SMSArrived",
   "smsType": "1",
   "apiVersion": "2013-12-26",
   "content": "4121908f3d1b4edb9210f0eb4742f62c",
   "fromNum": "008613800138000",
   "dateSent": "20130923010000",
   "deliverCode": "DELIVRD",
   "recvTime": "20130923010010",
   "status": "0",
   "reqId": "123",
   "smsCount": "2"，
   "spCode": ""
       }
}   

3.3 响应要求

• 客户端需要对回调请求响应 HTTP 200的正确状态，否则服务端会进行重试直到失败次数达到阈值
• 如出现接收问题请联系请联系商务经理或技术支持

4 批量获取国际短信状态报告接口

• 批量获取接口功能开启，请联系商务经理或售后客服配置
• 批量获取接口与回调功能两种获取方式只能选一

4.1 请求地址

4.2 请求包体

 POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/GetArrived?sig=
 C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1


 Host:192.168.0.1:8883
 content-length: 139
 Accept:application/json; 
 Content-Type:application/json;charset=utf-8; 
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
{"appId": "ff8080813fc70a7b013fc72312324213","smsType": "1","count": "200"}     

4.3 响应包体

HTTP/1.1 200 OK 
Content-Length: 487


{
  "statusCode": "000000",
  "reports": [{
      "content": "dd134b50e636433a96288f4ce5bb1630",
      "apiVersion": "2013-12-26",
      "fromNum": "00861380001380000",
      "status": "0",
      "smsType": "1",
      "recvTime": "20161202100328",
      "action": "SMSArrived",
      "dateSent": "20161202100325"
        }, {
      "content": "14477928a672437691c295e7dc6d63fb",
      "apiVersion": "2013-12-26",
      "fromNum": "005112345678",
      "status": "0",
      "smsType": "1",
      "recvTime": "20161202100332",
      "action": "SMSArrived",
      "dateSent": "20161202100330"
        }]
}