和信通短信平臺接口文檔
時間：2019-07-16 15:09:38
來源：admin
點擊：25110
接口說明：客戶接口部分提供http url方式的接口，根據客戶需求可以提供相應接口。
第一章 發送接口
1.1請求地址
請求地址是客戶接口程序調用時請求的url地址，采用的是http post 接口，地址是
http://123.57.51.191:8888/v2sms.aspx?對應UTF-8
http://123.57.51.191:8888/v2smsGBK.aspx?對應GB2312
入口地址一般不會發生變化，當發生變化的時候，會通知接口用戶
1.2參數說明
http://123.57.51.191:8888/v2sms.aspx
http://123.57.51.191:8888/v2smsGBK.aspx
|
參數名稱
|
含義
|
說明
|
|
userid
|
企業id
|
企業ID
|
|
timestamp
|
時間戳
|
系統當前時間字符串，年月日時分秒，例如：20120701231212
|
|
sign
|
簽名
|
使用 賬號+密碼+時間戳 生成MD5字符串作為簽名。MD5生成32位，且需要小寫
例如：
賬號是test
密碼是mima
時間戳是20120701231212
就需要用testmima20120701231212
來生成MD5的簽名，生成的簽名為5cc68982f55ac74348e3d819f868fbe1
|
|
mobile
|
全部被叫號碼
|
發信發送的目的號碼.多個號碼之間用半角逗號隔開
|
|
content
|
發送內容
|
短信的內容，內容需要UTF-8編碼
|
|
sendTime
|
定時發送時間
|
為空表示立即發送，定時發送格式2010-10-24 09:08:10
|
|
action
|
發送任務命令
|
設置為固定的:send
|
|
extno
|
擴展子號
|
請先詢問配置的通道是否支持擴展子號，如果不支持，請填空。子號只能為數字，且最多10位數。
|
例如：
action=send&userid=12×tamp=20120701231212&sign?=5cc68982f55ac74348e3d819f868fbe1&mobile=
13911776674,13911776674&content=內容&sendTime=&extno=
1.3返回值
在接收到客戶端發送的http請求后，返回以xml的方式返回處理結果。格式為：
status ---------- 返回狀態值：成功返回Success 失敗返回：Faild
message ---------- 返回信息：見下表
remainpoint ---------- 返回余額
taskID ?----------- ?返回本次任務的序列ID
successCounts --成功短信數：當成功后返回提交成功短信數
|
返回信息提示
|
說明
|
|
ok
|
提交成功
|
|
用戶名或密碼不能為空
|
提交的用戶名或密碼為空
|
|
發送內容包含sql注入字符
|
包含sql注入字符
|
|
用戶名或密碼錯誤
|
表示用戶名或密碼錯誤
|
|
短信號碼不能為空
|
提交的被叫號碼為空
|
|
短信內容不能為空
|
發送內容為空
|
|
包含非法字符：
|
表示檢查到不允許發送的非法字符
|
|
對不起，您當前要發送的量大于您當前余額
|
當支付方式為預付費是，檢查到賬戶余額不足
|
|
其他錯誤
|
其他數據庫操作方面的錯誤
|
第二章 余額及已發送量查詢接口
2.1請求地址
請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是
http://123.57.51.191:8888/v2sms.aspx
http://123.57.51.191:8888/v2smsGBK.aspx
入口地址一般不會發生變化，當發生變化的時候，會通知接口用戶
2.2參數說明
|
參數名稱
|
含義
|
說明
|
|
userid
|
企業id
|
企業ID
|
|
timestamp
|
時間戳
|
系統當前時間字符串，年月日時分秒，例如：20120701231212
|
|
sign
|
簽名
|
使用 賬號+密碼+時間戳 生成MD5字符串作為簽名。MD5生成32位，且需要小寫
例如：
賬號是test
密碼是mima
時間戳是20120701231212
就需要用testmima20120701231212
來生成MD5的簽名，生成的簽名為5cc68982f55ac74348e3d819f868fbe1
|
|
action
|
任務名稱
|
設置為固定的：overage
|
例如：
action=overage&userid=12×tamp=20120701231212&sign?=5cc68982f55ac74348e3d819f868fbe1
2.3返回值
status-------返回狀態值：成功返回Sucess (注意：此處是Sucess，和其它接口返回的Success不同)失敗返回：Faild
message--------------返回信息提示：見下表
payinfo--------------返回支付方式??后付費，預付費
overage-------------返回余額
sendTotal----返回總點數??當支付方式為預付費是返回總充值點數
|
返回信息提示
|
說明
|
|
返回空
|
查詢成功
將返回相應的支付方式、賬戶使用條數、總充值點數
|
|
用戶名或密碼不能為空
|
提交的用戶名或密碼為空
|
|
用戶名或密碼錯誤
|
表示用戶名或密碼錯誤
|
第三章 非法關鍵詞查詢
3.1請求地址
請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是
http://123.57.51.191:8888/v2sms.aspx
http://123.57.51.191:8888/v2smsGBK.aspx
入口地址一般不會發生變化，當發生變化的時候，會通知接口用戶
3.2參數說明
|
參數名稱
|
含義
|
說明
|
|
userid
|
企業id
|
企業ID
|
|
timestamp
|
時間戳
|
系統當前時間字符串，年月日時分秒，例如：20120701231212
|
|
sign
|
簽名
|
使用 賬號+密碼+時間戳 生成MD5字符串作為簽名。MD5生成32位，且需要小寫
例如：
賬號是test
密碼是mima
時間戳是20120701231212
就需要用testmima20120701231212
來生成MD5的簽名，生成的簽名為5cc68982f55ac74348e3d819f868fbe1
|
|
action
|
任務名稱
|
設置為固定的：checkkeyword
|
|
content
|
檢測發送內容
|
需要發送的內容
|
例如：
action=checkkeyword&userid=12×tamp=20120701231212&sign?=5cc68982f55ac74348e3d819f868fbe1&content=內容
3.3返回值
message--------------返回信息提示：見下表
|
返回信息提示
|
說明
|
|
用戶名或密碼不能為空
|
提交的用戶名或密碼為空
|
|
用戶名或密碼錯誤
|
表示用戶名或密碼錯誤
|
|
包含非法字符
|
檢查出來包含非法關鍵詞
|
|
沒有包含屏蔽詞
|
未檢查出非法關鍵詞
|
第四章 狀態報告接口
4.1請求地址
請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是
http://123.57.51.191:8888/v2statusApi.aspx
入口地址一般不會發生變化，當發生變化的時候，會通知接口用戶
注意：相同的狀態報告，只能獲取一次。
4.2參數說明
|
參數名稱
|
含義
|
說明
|
|
userid
|
企業id
|
企業ID
|
|
timestamp
|
時間戳
|
系統當前時間字符串，年月日時分秒，例如：20120701231212
|
|
sign
|
簽名
|
使用 賬號+密碼+時間戳 生成MD5字符串作為簽名。MD5生成32位，且需要小寫
例如：
賬號是test
密碼是mima
時間戳是20120701231212
就需要用testmima20120701231212
來生成MD5的簽名，生成的簽名為5cc68982f55ac74348e3d819f868fbe1
|
|
statusNum
|
每次取得號碼數
|
必須為數字，默認4000，可不填
|
|
action
|
任務名稱
|
設置為固定的：query
|
例如：
action=query&userid=12×tamp=20120701231212&sign?=5cc68982f55ac74348e3d819f868fbe1
4.3返回值
13911776674-------------對應的手機號碼
1212-------------同一批任務ID
10---------狀態報告----10：發送成功，20：發送失敗
2011-12-02 22:12:11-------------接收時間
DELIVRD-上級網關返回值，不同網關返回值不同，僅作為參考
01--子號，即自定義擴展號
13911776674
1212
20
2011-12-02 22:12:11
2
4.4錯誤返回值——狀態報告請求錯誤返回格式及對應值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述
1：用戶名或密碼不能為空
2：用戶名或密碼錯誤
3：該用戶不允許查看狀態報告
4：參數不正確
第五章 上行接口
5.1請求地址
請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是
http://123.57.51.191:8888/v2callApi.aspx
入口地址一般不會發生變化，當發生變化的時候，會通知接口用戶
注意：相同的上行回復，只能獲取一次。
5.2參數說明
|
參數名稱
|
含義
|
說明
|
|
userid
|
企業id
|
企業ID
|
|
timestamp
|
時間戳
|
系統當前時間字符串，年月日時分秒，例如：20120701231212
|
|
sign
|
簽名
|
使用 賬號+密碼+時間戳 生成MD5字符串作為簽名。MD5生成32位，且需要小寫
例如：
賬號是test
密碼是mima
時間戳是20120701231212
就需要用testmima20120701231212
來生成MD5的簽名，生成的簽名為5cc68982f55ac74348e3d819f868fbe1
|
|
action
|
任務名稱
|
設置為固定的：query
|
例如：
action=query&userid=12×tamp=20120701231212&sign?=5cc68982f55ac74348e3d819f868fbe1
5.3返回值
13911776674-------------對應的手機號碼
1212-------------同一批任務ID
你好，我不需要---------上行內容
2011-12-02 22:12:11-------------接收時間
01----子號，即自定義擴展號
13911776674
1212
你好，本次活動路線是怎么的
2011-12-02 22:12:11
01
5.4錯誤返回值——回復請求錯誤返回格式及對應值
1-------------錯誤碼
用戶名或密碼不能為空-------------錯誤描述
1：用戶名或密碼不能為空
2：用戶名或密碼錯誤
3：該用戶不允許查看狀態報告
4：參數不正確
技術支持?(下載技術文檔)
售前客服 
