模板短信业务接口

1 概述

1.1 业务流程说明

1.2 Base URL

1.3 业务URL

1.4 HTTP标准包头字段

2 发送模板短信接口

2.1 请求地址

2.2 请求包体

 POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/TemplateSMS?sig=
 C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
 Host:192.168.0.1:8883
 content-length: 139
 Accept:application/xml; 
 Content-Type:application/xml;charset=utf-8; 
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 <?xml version='1.0' encoding='utf-8'?> 
 <TemplateSMS>
  <to>13912345678</to>
  <appId>ff8080813c37da53013c3054f567007e</appId> 
  <templateId>1</templateId>
  <reqId>abc123</reqId>
  <subAppend>8888</subAppend>
  <datas>
    <data>替换内容</data>
    <data>替换内容</data>
  </datas>
 </TemplateSMS>            
            

 POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/TemplateSMS?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=
 
 {"to":"13911281234,15010151234,13811431234","appId":"ff8080813fc70a7b013fc72312324213","reqId":"abc123","subAppend":"8888","templateId":"1","datas":["替换内容","替换内容"]}           
            

2.3 响应包体

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

  HTTP/1.1 200 OK 
  Content-Length: 641 
  
  <?xml version="1.0" encoding="UTF-8" standalone="yes"?&;
  <Response>
   <statusCode>000000</statusCode>
    <TemplateSMS>
      <smsMessageSid>ff8080813c373cab013c94b0f0512345</smsMessageSid>
      <dateCreated>20130201153809</dateCreated>
    </TemplateSMS>
  </Response>          
            

 HTTP/1.1 200 OK 
 Content-Length: 641
 
 {"statusCode":"000000","templateSMS":{"dateCreated":"20130201155306","smsMessageSid":" ff8080813c373cab013c94b0f0512345"}}        
            

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>13912345678</fromNum>
 <deliverCode>DELIVRD</deliverCode>
 <content>4121908f3d1b4edb9210f0eb4742f62c</content>
 <reqId>123</reqId>
 <status>0</status>
 <smsCount>2</smsCount>
 <dateSent>20130923010000</dateSent>
 <spCode>10690876</spCode>
</Request>          
            

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

3.3 响应要求

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

4 批量获取短信状态报告、上行短信信息接口

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

4.1 请求地址

4.2 请求包体

 POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/SMS/TemplateSMS?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”}       
            

4.3 响应包体

 HTTP/1.1 200 OK 
 Content-Length: 641
 
{"statusCode":"000000","reports":[{"content":"dd134b50e636433a96288f4ce5bb1630","apiVersion":"2013-12-26","fromNum":"18626622933","status":"0","smsType":"1","recvTime":"20161202100328","action":"SMSArrived","dateSent":"20161202100325"},{"content":"14477928a672437691c295e7dc6d63fb","apiVersion":"2013-12-26","fromNum":"18616863107","status":"0","smsType":"1","recvTime":"20161202100332","action":"SMSArrived","dateSent":"20161202100330"}]}