<listing id="l7wus"></listing>
      1. <source id="l7wus"></source>
        1. 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日

          狠狠射小说