短信接口接入流程

SMS云信支持HTTPS短信接口和HTTP短信接口

https://api.sms.cn 支持Apple ATS 短信接口數據提交保證你數據安全

證書（安全）

安全的證書的公鑰算法（RSA2048位以上或ECC256位以上）

安全的證書簽名算法（SHA2）

證書被 Apple ATS 信任（權威機構頒發）

證書與域名匹配（包含被檢測的域名）

證書到期時間有效（未過期）

服務器（安全）

開啟HTTPS

服務器配置符合ATS規范

支持TLS1.2

PFS（完全正向保密）

iOS 密碼套件支持

短信API接口(短信接口文檔開發)

一、短信接口工作方式

雙方通過HTTP或HTTPS方式交互數據，第三方可以簡單的“name=value”方式發送提交內容或響應請求內容。即通過HTTP或HTTPS的GET/POST方式交換。
另外雙方需要保證數據傳輸的完整性和安全性，每次發送請求都有響應(響應返回格式為純文本)，安全驗證目前采用用戶名、密碼和IP綁定的方式。

1.1 短信接口密碼驗證方式

短信接口密碼使用“登錄密碼”與“用戶名”拼接字符串后能過md5加密進行驗證
如登錄密碼是：123123
如用戶名是：test
接口密碼（pwd）=md5(登錄密碼+用戶名)
pwd=md5(123123test)
pwd=b9887c5ebb23ebb294acab183ecf0769

二、字符編碼

服務器接收數據可以是GBK或UTF-8編碼字符;
默認接收數據是UTF-8編碼,如提交的是GBK編碼字符,需要添加參數encode=gbk。

三、響應格式

所為響應即每次向服務器提交請求后返回值
響應值格式有：JSON、XML、純文本
默認：JSON格式

短信接口發送
接收狀態報告
接收回復短信
取剩余條數
已發送總條數
取發送記錄
添加短信模板
修改密碼
安全（綁定IP）

▲ 短信發送

去調試>>

JSON變量模板發送

GET/POST操作格式：http://api.sms.cn/sms/?ac=send&uid=用戶賬號&pwd=MD532位密碼&mobile=號碼&content={"key":"內容"}

短信接口參數說明:

參數名	參數字段	參數說明
ac	接口功能	接口功能，傳入值請填寫 send
uid	用戶賬號	登錄名
pwd	用戶密碼	32位MD5加密md5(密碼+uid) 如登錄密碼是：123123 ，uid是：test; pwd=md5(123123test) pwd=b9887c5ebb23ebb294acab183ecf0769
mobile	接收號碼	短信接口同時發送給多個號碼時,號碼之間用英文半角逗號分隔(,);小靈通需加區號如:13972827282,13072827282
content	短信內容	JSON變量模板發送，傳參規則{"key":"value"}JSON格式，key的名字須和申請模板中的變量名一致，多個變量之間以逗號隔開。示例：針對模板“短信驗證碼{$code}，您正在進行{$product}身份驗證，請在10分鐘內完成操作！”，傳參時需傳入{"code":"352333","product":"電商平臺"}
template	模板短信ID	發送變量模板短信時需要填寫對應的模板ID號，進入平臺-》短信設置-》模板管理
time	返回格式	可選項，格式：年月日時分，定時時間到分,共12個數字如定時到2032-10-01 12:01發 time=203210011201
format	返回格式	可選項，有三參數值：json,xml,txt 默認json格式
encode	字符編碼	可選項，默認接收數據是UTF-8編碼,如提交的是GBK編碼字符,需要添加參數 encode=gbk
mobileids	消息編號	可選項該參數用于發送短信收取狀態報告用，格式為消息編號+逗號；與接收號碼一一對應，可以重復出現多次。消息編號:全部由數字組成接收狀態報告的時候用到，該消息編號的格式可就為目標號碼+當前時間戳整數，精確到毫秒，確保唯一性。供收取狀態報告用如: 1590049111112869461937;

例:
你在平臺添加了JSON變量模板如下：
短信驗證碼{$code}，您正在進行{$product}身份驗證，請在10分鐘內完成操作！
模板ID：100001
接收號：13900008888

接口內容JSON格式：
{"key":"234336","product":"電商平臺"}
http://api.sms.cn/sms/?ac=send&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=13900008888&content= {"key":"234336","product":"電商平臺"}&template=100001

~~注：發送內容content需要進行URL字符標準化轉碼。~~

響應結果值:
json格式
{"stat":"100","message":"發送成功"}
xml格式
<result><stat>100</stat><message>發送成功</message></result>
txt 文本字符格
sms&stat=100&message=發送成功

stat 狀態碼
message 狀態說明

返回發送的狀態碼
狀態碼       說明
100        發送成功
101        驗證失敗
102        短信不足
103        操作失敗
104        非法字符
105        內容過多
106        號碼過多
107        頻率過快
108        號碼內容空
109        賬號凍結
112        號碼錯誤
113        定時出錯
116        禁止接口發送
117        綁定IP不正確
161        未添加短信模板
162        模板格式不正確
163        模板ID不正確
164        全文模板不匹配
166        模板內容重復
167        模板審核中
168        模板審核不通過

調試頁面 : 去調試>>

全文變量模板發送

GET/POST操作格式：http://api.sms.cn/sms/?ac=send&uid=用戶賬號&pwd=MD532位密碼&mobile=號碼&content=內容

短信接口參數說明:

參數名	參數字段	參數說明
ac	接口功能	接口功能，傳入值請填寫 send
uid	用戶賬號	登錄名
pwd	用戶密碼	32位MD5加密md5(密碼+uid) 如登錄密碼是：123123 ，uid是：test; pwd=md5(123123test) pwd=b9887c5ebb23ebb294acab183ecf0769
mobile	接收號碼	短信接口同時發送給多個號碼時,號碼之間用英文半角逗號分隔(,);小靈通需加區號如:13972827282,13072827282
content	短信內容	發送內容需要進行URL字符標準化轉碼。 {URL字符編碼說明:返回字符串，此字符串中除了-_.之外的所有非字母數字字符都將被替換成百分號（%）后跟兩位十六進制數，空格則編碼為加號（+）} ASP：server.URLEncode("短信內容") PHP：urlencode("短信內容") JAVA：java.net.URLEncoder.encode("短信內容")
time	返回格式	可選項，格式：年月日時分，定時時間到分,共12個數字如定時到2032-10-01 12:01發 time=203210011201
format	返回格式	可選項，有三參數值：json,xml,txt 默認json格式
mobileids	消息編號	可選項該參數用于發送短信收取狀態報告用，格式為消息編號+逗號；與接收號碼一一對應，可以重復出現多次。消息編號:全部由數字組成接收狀態報告的時候用到，該消息編號的格式可就為目標號碼+當前時間戳整數，精確到毫秒，確保唯一性。供收取狀態報告用如: 1590049111112869461937;
encode	字符編碼	可選項，默認接收數據是UTF-8編碼,如提交的是GBK編碼字符,需要添加參數 encode=gbk

例:
你在平臺添加了全文變量模板內容如下：
你好！{**},您的驗證碼：{**}。如非本人操作，可不用理會！【公司簽名】
接收號：13900008888

短信接口發送內容：
你好！testuser,您的驗證碼：234346。如非本人操作，可不用理會！【公司簽名】
http://api.sms.cn/sms/?ac=send&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=13900008888&content=你好！testuser,您的驗證碼：234346。如非本人操作，可不用理會！【公司簽名】

~~注：發送內容content需要進行URL字符標準化轉碼。~~

stat 狀態碼
message 狀態說明

調試頁面 : 去調試>>

▲ 接收狀態報告

去調試>>

獲取狀態短信接口

GET/POST操作格式：http://api.sms.cn/sms/?ac=status&uid=用戶賬號&pwd=MD532位密碼

短信接口參數說明:

參數名	參數字段	參數說明
ac	接口功能	接口功能，傳入值請填寫 status
uid	用戶賬號
pwd	用戶密碼	32位MD5加密 md5(登錄密碼+用戶賬號)

~~例:http://api.sms.cn/sms/?ac=status&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769~~

響應返回值:
json格式
{"stat":"100","total":"50","values":
[
{"retime":"2010-11-14 18:04:19","mobile":"13900008888","mobileids":"1390000888800001","resultcode":"100","status":"DELIVRD"},
{"retime":"2010-11-14 18:09:19","mobile":"13900008888","mobileids":"1390000888800001","resultcode":"100","status":"DELIVRD"}
]
}
xml格式
<result>
<stat>100</stat>
<total>300</total>
<values>
<value0><retime>2016-04-11 11:04:35</retime><mobile>14778557233</mobile><mobileids>147785572331460343857</mobileids><resultcode>100</resultcode><status>DELIVRD</status></value0>
<value1><retime>2016-04-11 11:04:31</retime><mobile>13914455766</mobile><mobileids>139144557669924723</mobileids><resultcode>100</resultcode><status>DELIVRD</status></value1>
</values>
</result>

響應結果值說明:

參數	說明
stat	接口狀態 100 成功
total	當前總記錄數量
retime	狀態返回時間
mobile	手機號
mobileids	發送唯一編號
resultcode	狀態碼: 100 //成功 130 //失敗 131 //空號 132 //停機 133 //關機 134 //無狀態
status	運營網關狀態

調試頁面 : 去調試>>

推送接收狀態報告

發送狀態報告請求消息
使用說明：
由服務器平臺發送狀態報告到您的接口程序上，使用Http協議GET和POST方式發送，您需要提交一個http接口地址來接收如下格式參數值
操作的格式：
http://您服務器接口地址?cmd=stat&uid=用戶賬號&mobileids=消息編號&mobile=接收號碼&status=消息狀態

短信接口參數說明:

參數名	參數字段名	說明
cmd	操作命令	返回值：stat
uid	用戶賬號	返回值：發送短信用戶名
mobileids	消息編號	返回值：消息編號
mobile	接收號碼	返回值：接收的號碼
resultcode	狀態碼	100 //成功 130 //失敗 131 //空號 132 //停機 133 //關機 134 //無狀態

~~例:http://您服務器接口地址?cmd=stat&uid=test&mobileids=1590049111112869461937&mobile=15900491111&status=100~~

調試頁面 : 去調試>>

▲ 接收上行回復短信接口

去調試>>

主動獲取上行短信（回復）

操作的格式：http://api.sms.cn/sms/?ac=reply&uid=用戶賬號&pwd=MD532位密碼。注：提取的回復短信不能在重復提取

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	傳入值請填寫 status
format	返回格式	有三參數值：json,xml 默認json格式
uid	返回格式	有三參數值：json,xml 默認json格式
pwd	用戶密碼	小寫32位MD5加密
encode	字符編碼	可選項，默認接收數據是GBK編碼,如提交的是UTF-8編碼字符,需要添加參數 encode=utf8

~~例:http://api.sms.cn/sms/?ac=reply&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769~~

響應結果為JSON和XML
JSON
{"stat":"100","total":"100","values":[ {"retime":"2012-04-13 10:00:23","mobile":"15900001111","content":"謝謝你！"},{"retime":"2012-04-13 09:59:50","mobile":"15900001111","content":"收到"} ]}
XML
<result>
<stat>100</stat>
<total>100</total>
<values>
<value0><retime>2012-04-13 10:00:23</retime><mobile>15900001111</mobile><content>謝謝你！</content></value0>
<value1><retime>2012-04-13 09:59:50</retime><mobile>15900001111</mobile><content>收到</content></value1>
</values>
</result>

響應結果值說明:

參數	說明
stat	接口狀態 100 成功
total	當前總記錄數量
retime	回復時間
mobile	回復手機號
content	回復內容

調試頁面 : 去調試>>

推送接收上行短信（回復）

使用說明：由服務器平臺發送上行回復短信到您的接口程序上，使用Http協議GET和POST方式發送，您需要提交一個http接口地址來接收如下格式參數值

操作的格式：http://您服務器接口地址?cmd=res&uid=用戶賬號&mobileids=消息編號&mobile=接收號碼&status=消息狀態

短信接口參數說明:

參數名	參數字段名	說明
cmd	操作命令	返回值：res
uid	用戶賬號	返回值：發送短信用戶名
time	回復時間	返回值：YYYY-MM-DD HH:II:SS
mobile	接收號碼	返回值：接收的號碼
content	消息內容	返回值：UTF-8字符串

調試頁面 : 去調試>>

▲ 取剩余短信條數

去調試>>

操作格式：http://api.sms.cn/sms/?ac=number&uid=用戶賬號&pwd=MD5位32密碼

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	傳入值請填寫 number
format	返回格式	有三參數值：json,xml 默認json格式
uid	用戶賬號
pwd	用戶密碼	32位MD5加密

~~例:http://api.sms.cn/sms/?ac=number&uid=test&pwd=fa246d0262c3925617b0c72bb20eeb1d~~

響應結果：
JSON
{"stat":"100","number":"2123432"}
XML
<result>
<stat>100</stat>
<number>2123432</number>
</result>
sms&stat=100&remain=100

調試頁面 : 去調試>>

▲ 取已發送總條數

去調試>>

操作格式：http://api.sms.cn/sms/?ac=number&uid=用戶賬號&pwd=MD5位32密碼&cmd=send

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	傳入值請填寫 number
uid	用戶賬號
pwd	用戶密碼	32位MD5加密
cmd	send	取已發送條數

響應結果：
JSON
{"stat":"100","number":"2123432"}
XML
<result>
<stat>100</stat>
<number>2123432</number>
</result>

調試頁面 : 去調試>>

▲ 取發送記錄

去調試>>

操作的格式：http://api.sms.cn/sms/?ac=query&uid=用戶賬號&pwd=MD532位密碼

短信接口參數說明:每次最多取50條記錄，記錄只能取一次，取過的記錄不能在取

參數名	參數字段名	說明
ac	接口功能	傳入值請填寫 nquery
uid	用戶賬號
pwd	用戶密碼	小寫32位MD5加密
date	日期	可選項，取指定日期記錄（2011-12-12）
key	查詢號碼	可選項，取指定手機號記錄
encode	字符編碼	可選項，默認接收數據是GBK編碼,如提交的是UTF-8編碼字符,需要添加參數 encode=utf8

~~例:http://api.sms.cn/sms/?ac=query&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769~~

響應結果為JOSN或XML格式
返回如下格式：
JSON格式
{"stat":100,"total":"1896397","page_size":"50","total_page":"37928", "values":[
{"sendtime":"2013-11-14 18:04:19","mobile":"13900008888","content":"我的發送記錄1【云信】","status":"1"},
{"sendtime":"2013-11-14 18:04:19","mobile":"13900008888","content":"我的發送記錄2【云信】","status":"1"}
]}
無回復內容時返回空
{"total":"0","page_size":"0","total_page":"0"}
XML格式
<result>
<stat>100</stat>
<total>1896347</total>
<page_size>50</page_size>
<total_page>37928</total_page>
<values>
<value0>
<sendtime>2013-11-14 18:04:19</sendtime>
<mobile>13900008888</mobile>
<content>發送的內容1</content>
<status>1</status>
</value0>
<value1>
<sendtime>2013-11-14 18:04:19</sendtime>
<mobile>13900008888</mobile>
<content>發送的內容2</content>
<status>1</status>
</value1>
</values>
</result>
無回復內容時返回空
<result>
<total>0</total><page_size>0</page_size><total_page>0</total_page>
</result>

響應結果值說明:

參數	說明
stat	接口狀態 100 成功
total	總記錄數量
page_size	當前記錄數量
total_page	總頁數
sendtime	發送時間
mobile	手機號
content	發送的內容
status	提交狀態[status:發送狀態 1 提交成功 0 提交失敗]

調試頁面 : 去調試>>

▲ 短信模板

添加短信模板

GET/POST操作格式：http://api.sms.cn/sms/?ac=template&uid=用戶名&pwd=32位MD5加密&title=短信模板標題&content=要添加的模板內容

短信接口參數說明:

參數名	參數字段	參數說明
ac	接口功能	接口功能，傳入值請填寫 template
uid	用戶賬號	登錄名
pwd	用戶密碼	32位MD5加密md5(密碼+uid) 如登錄密碼是：123123 ，uid是：test; pwd=md5(123123test) pwd=b9887c5ebb23ebb294acab183ecf0769
title	模板標題	模板標題名稱用于備注查詢[選填]
content	模板內容	模板內容包含短信內容和簽名。全文變量模板的變量用{**}代替，JSON變量模板的變量用源碼中相應的變量參數代替。
type	模板類型	1.驗證碼 2.通知 3.推廣
dataformat	模板格式	1.全文變量模板 2.JSON變量模（不填寫默認為全文變量模板）[選填]
templateid	模板ID	修改JSON變量模板時，需添加相應的模板ID，根據模板ID來修改已申請過的模板內容，空就是添加，填寫對應模板ID就是修改。[選填]
delete	刪除模板	delete=1 刪除指定模板ID模板 [選填]

例如1:
添加全文模板內容：
您好，您的驗證碼是：{**}【公司簽名】

格式：
http://api.sms.cn/sms/?ac=template&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&&content=您好，您的驗證碼是：{**}【公司簽名】

~~注：發送內容content需要進行URL字符標準化轉碼。~~

例如2:
添加JSON模板內容：
您好，您的驗證碼是：{$code}【公司簽名】

格式：
http://api.sms.cn/sms/?ac=template&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&dataformat=2&content=您好，您的驗證碼是：{$code}【公司簽名】

~~注：發送內容content需要進行URL字符標準化轉碼。~~

響應結果值:
json格式
{"stat":"100","templateid":"383533","message":"添加成功"}
xml格式
<result><stat>100</stat><templateid>383533</templateid><message>添加成功</message></result>
txt 文本字符格
sms&stat=100&templateid=383533&message=添加成功

stat 狀態碼
message 狀態說明

返回發送的狀態碼
狀態碼       說明
100        模板添加成功
118        無法添加沒有簽名
161        模板ID不存在
166        模板內容重復

調試頁面 : 去調試>>

短信模板審核狀態查詢

操作格式：http://api.sms.cn/sms/?ac=templatestatus&uid=用戶賬號&pwd=MD5位32密碼&templateid=模板ID

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	接口功能，傳入值請填寫 templatestatus
format	返回格式	可選項，參數值：json,xml 默認json格式
uid	用戶賬號
pwd	用戶密碼	32位MD5加密
templateid	模板ID	請填寫要查詢的模板ID

~~例:http://api.sms.cn/sms/?ac=templatestatus&uid=test&pwd=5f6a3e3ace0262caabc42a9618a78c68&templateid=232311~~

響應結果：
JSON
{"stat":"100","message":"模板成功通過"}

{"stat":"168","message":"模板不通過","question":"模板里沒有添加簽名如：【公司名稱】簽名建議為用戶真實應用名/網站名/公司名。"}
XML格式
<result>
<stat>100</stat>
<message>模板成功通過</message>
</result>

取短信模板記錄

操作格式：http://api.sms.cn/sms/?ac=templatequery&uid=用戶賬號&pwd=MD532位密碼

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	接口功能，傳入值請填寫 templatequery
format	返回格式	可選項，參數值：json,xml 默認json格式
uid	用戶賬號
pwd	用戶密碼	32位MD5加密
page	取第幾頁	可選項，默認1（第一頁）
encode	字符編碼	可選項，默認接收數據是GBK編碼,如提交的是UTF-8編碼字符,需要添加參數 encode=utf8

~~例:http://api.sms.cn/sms/?ac=templatequery&uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&page=1~~

響應結果：
JSON
{"stat":100,"total":"1000","page_size":"100","total_page":"10","page":"1", "values":[ {"type":"1","dataformat":"2","addtime":"2013-11-14 18:04:19","templateid":"13900008888","content":"驗證碼：{$code}，請及時完成驗證?！竟竞灻?,"question":"","status":"1"}, {"type":"1","dataformat":"1","addtime":"2013-11-14 18:04:19","templateid":"13900008888","content":"您的登錄驗證碼：{**}，請及時完成驗證?！竟竞灻?,"question":"模板里沒有添加簽名","status":"2"} ]}
無模板時返回
{"total":"0","page_size":"0","total_page":"0"}
XML格式
<result>
<stat>100</stat>
<total>1000</total>
<page_size>100</page_size>
<total_page>10</total_page>
<page>1</page>
<values>
<value0>
<type>1</type>
<dataformat>2</dataformat>
<addtime>2013-11-14 18:04:19</addtime>
<templateid>322542</templateid>
<content>驗證碼：{$code}，請及時完成驗證?！竟竞灻?lt;/content>
<question></question>
<status>0</status>
</value0>
<value1>
<type>1</type>
<dataformat>1</dataformat>
<addtime>2013-11-14 18:04:19</addtime>
<templateid>322545</templateid>

▲ 修改密碼

去調試>>

操作格式：http://api.sms.cn/sms/?ac=pass&uid=用戶賬號&pwd=MD5位32密碼&newpass=新密碼

短信接口參數說明:

參數名	參數字段名	說明
ac	接口功能	接口功能，傳入值請填寫 pass
format	返回格式	可選項，參數值：json,xml 默認json格式
uid	用戶賬號
pwd	用戶密碼	32位MD5加密
newpass	新密碼	新密碼