1 模板短信接口恳求方法

1.1 业务流程阐明

1.2 Base URL

模板短信API引证的地址有Base URL。

出产环境的Base URL:https://app.cloopen.com:8883

留意:为了保证数据隐私,云通讯渠道的REST API是经过HTTPS方法恳求。

1.3 一致恳求包头

URL格局:/2013-12-26/Accounts/{accountSid}/SMS/TemplateSMS?sig={SigParameter}

在URL格局中 {}内的内容标明为参数,非{}的内容固定不变。

特点阐明:

特点 类型 束缚 阐明
accountSid
String 必选
开发者主账户ACCOUNT SID(登陆官网在办理控制台获取)
SigParameter
String 必选

REST API 验证参数,生成规矩如下

1.运用MD5加密(账户Id + 账户授权令牌 + 时刻戳)。其间账户Id和账户授权令牌依据url的验证等级对应主账户。

时刻戳是当时体系时刻,格局"yyyyMMddHHmmss"。时刻戳有用时刻为24小时,如:20140416142030

2.SigParameter参数需求大写,如不能写成sig=abcdefg而应该写成sig=ABCDEFG

1.4 HTTP规范包头字段

Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Content-Length:256;
Authorization:

特点阐明:

特点 类型 束缚 阐明
Accept
String 必选 客户端呼应接纳数据格局:application/xml、application/json
Content-Type
String 必选 类型:application/xml;charset=utf-8、application/json;charset=utf-8
Content-Length
String 必选 Content-Length

Authorization

String

必选

验证信息,生成规矩详见下方阐明

1.运用Base64编码(账户Id + 冒号 + 时刻戳)其间账户Id依据url的验证等级对应主账户

2.冒号为英文冒号

3.时刻戳是当时体系时刻,格局"yyyyMMddHHmmss",需与SigParameter中时刻戳相同。

1.5 恳求包体

特点
类型 束缚 阐明
to String 必选 短信接纳端手机号码调集,用英文逗号分隔,每批发送的手机号数量不得超越200个
appId
String 必选 使用Id
templateId String 必选 模板Id
datas String 可选 内容数据外层节点,模板假如没有变量,此参数可不传
data
String
可选
内容数据,用于替换模板中{序号}

1.5.1 XML恳求示例

 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>
  <datas>
    <data>替换内容</data>
    <data>替换内容</data>
  </datas>
</TemplateSMS>            
            

1.5.2 JSON恳求示例

 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","templateId":"1","datas":["替换内容","替换内容"]}           
            

1.6 呼应

此步呼应只标明客户的短信恳求发送成功,不标明短信通道现已发送短信成功。

特点 类型 束缚 阐明

statusCode

String

必选

恳求状况码,取值000000(成功)

smsMessageSid
String 必选 短信仅有标识符
dateCreated
String 必选 短信的创立时刻

1.6.1 XML呼应示例

  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>          
            

1.6.2 JSON呼应示例

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

1.7 判别发送失利,重发

对呼应解析后,statusCode为"000000"标明恳求发送成功。statusCode不是"000000",标明恳求发送失利,客户服务端能够依据自己的逻辑进行重发或许其他处理。

文档更新时刻:2017年7月7日