（HTTP）金牌信通V8-生意虎信驗證碼插件

金牌信通V8-生意虎信驗證碼插件

（HTTP）

客戶接口說明 1

第一章  發送接口 2

1.1 請求地址 2

1.2參數說明 2

1.3返回值 2

第二章 餘額及已發送量查詢接口 3

2.1 請求地址 3

2.2參數說明 3

2.3返回值 3

第三章 非法關鍵詞查詢 4

3.1 請求地址 4

3.2參數說明 4

3.3返回值 4

第四章 狀態報告接口 5

4.1 請求地址 5

4.2參數說明 5

4.3返回值 5

4.4錯誤返回值——狀態報告請求錯誤返回格式及對應值 6

第五章 上行接口 6

5.1 請求地址 6

5.2參數說明 6

5.3返回值 7

5.4錯誤返回值——回覆請求錯誤返回格式及對應值 7

接口說明：客戶接口部分提供http url方式的接口，根據客戶需求能夠提供相應接口，接口編碼方式採用統一的UTF-8

第一章  發送接口

1.1 請求地址

請求地址是客戶接口程序調用時請求的url地址，採用的是http post 接口，地址是

http:// 120.26.59.83:8888/sms.aspx 對應UTF-8

http:// 120.26.59.83:8888/smsGBK.aspx 對應GB2312

入口地址通常不會發生變化，當發生變化的時候，會通知接口用戶

1.2參數說明

http:// 120.26.59.83:8888/sms.aspx

http:// 120.26.59.83:8888/smsGBK.aspx

 

參數名稱	含義	說明
userid	企業id	企業ID
account	發送用戶賬號	用戶賬號，由系統管理員
password	發送賬號密碼	用戶帳號對應的密碼
mobile	所有被叫號碼	發信發送的目的號碼.多個號碼之間用半角逗號隔開
content	發送內容	短信的內容，內容須要UTF-8編碼
sendTime	定時發送時間	爲空表示當即發送，定時發送格式2010-10-24 09:08:10
action	發送任務命令	設置爲固定的:send
extno	擴展子號	請先詢問配置的通道是否支持擴展子號，若是不支持，請填空。子號只能爲數字，且最多5位數。

例如：

action=send&userid=12&account=帳號&password=密碼&mobile=15023239810,13527576163&content=內容&sendTime=&extno=

1.3返回值

在接收到客戶端發送的http請求後，返回以xml的方式返回處理結果。格式爲：

 

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<returnstatus>status</returnstatus> ---------- 返回狀態值：成功返回Success 失敗返回：Faild

<message>message</message> ---------- 返回信息：見下表

<remainpoint> remainpoint</remainpoint> ---------- 返回餘額

 

<taskID>taskID</taskID>  -----------  返回本次任務的序列ID

<successCounts>successCounts</successCounts> --成功短信數：當成功後返回提交成功短信數

</returnsms>

 

返回信息提示	說明
ok	提交成功
用戶名或密碼不能爲空	提交的用戶名或密碼爲空
發送內容包含sql注入字符	包含sql注入字符
用戶名或密碼錯誤	表示用戶名或密碼錯誤
短信號碼不能爲空	提交的被叫號碼爲空
短信內容不能爲空	發送內容爲空
包含非法字符：	表示檢查到不容許發送的非法字符
對不起，您當前要發送的量大於您當前餘額	當支付方式爲預付費是，檢查到帳戶餘額不足
其餘錯誤	其餘數據庫操做方面的錯誤

 

第二章 餘額及已發送量查詢接口

2.1 請求地址

請求地址是客戶接口程序調用的時候請求的url地址，採用的是http post接口，地址是

http:// 120.26.59.83:8888/sms.aspx

http:// 120.26.59.83:8888/smsGBK.aspx

入口地址通常不會發生變化，當發生變化的時候，會通知接口用戶

2.2參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號，由系統管理員
password	賬號密碼	用戶帳號對應的密碼
action	任務名稱	設置爲固定的：overage

例如：

action=overage&userid=12&account=帳號&password=密碼

2.3返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<returnstatus>status</returnstatus>-------返回狀態值：成功返回Success 失敗返回：Faild

<message>message</message>--------------返回信息提示：見下表

<payinfo>payinfo</payinfo>--------------返回支付方式  後付費，預付費

<overage>overage</overage>-------------返回餘額

<sendTotal>sendTotal</sendTotal>----返回總點數  當支付方式爲預付費是返回總充值點數

</returnsms>

 

返回信息提示	說明
返回空	查詢成功 將返回相應的支付方式、帳戶使用條數、總充值點數
用戶名或密碼不能爲空	提交的用戶名或密碼爲空
用戶名或密碼錯誤	表示用戶名或密碼錯誤

 

 

第三章 非法關鍵詞查詢

3.1 請求地址

請求地址是客戶接口程序調用的時候請求的url地址，採用的是http post接口，地址是

http:// 120.26.59.83:8888/sms.aspx

http:// 120.26.59.83:8888/smsGBK.aspx

入口地址通常不會發生變化，當發生變化的時候，會通知接口用戶

3.2參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號，由系統管理員
password	賬號密碼	用戶帳號對應的密碼
action	任務名稱	設置爲固定的：checkkeyword
content	檢測發送內容	須要發送的內容

例如：

action=checkkeyword&userid=12&account=帳號&password=密碼&content=內容

3.3返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnsms>

<message>message</message>--------------返回信息提示：見下表

</returnsms>

 

返回信息提示	說明
用戶名或密碼不能爲空	提交的用戶名或密碼爲空
用戶名或密碼錯誤	表示用戶名或密碼錯誤
包含非法字符	檢查出來包含非法關鍵詞
未包含非法字符	未檢查出非法關鍵詞

第四章 狀態報告接口

4.1 請求地址

請求地址是客戶接口程序調用的時候請求的url地址，採用的是http post接口，地址是

http:// 120.26.59.83:8888/statusApi.aspx

入口地址通常不會發生變化，當發生變化的時候，會通知接口用戶

4.2參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號，由系統管理員
password	賬號密碼	用戶帳號對應的密碼
action	任務名稱	設置爲固定的：query

例如：

action=query&userid=12&account=帳號&password=密碼

4.3返回值

<?xml version="1.0" encoding="utf-8" ?> 

<returnsms>

<statusbox>

<mobile>15023239810</mobile>-------------對應的手機號碼

<taskid>1212</taskid>-------------同一批任務ID

<status>10</status>---------狀態報告----10：發送成功，20：發送失敗

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收時間

<errorcode>DELIVRD</errorcode>-上級網關返回值，不一樣網關返回值不一樣，僅做爲參考

</statusbox>

<statusbox>

<mobile>15023239811</mobile>

<taskid>1212</taskid>

<status>20</status>

<receivetime>2011-12-02 22:12:11</receivetime>

<errorcode>2</errorcode>

</statusbox>

</returnsms>

4.4錯誤返回值——狀態報告請求錯誤返回格式及對應值

<?xml version="1.0" encoding="utf-8" ?> 

<returnsms>

<errorstatus>

<error>1</error>-------------錯誤碼

<remark>用戶名或密碼不能爲空</remark>-------------錯誤描述

</errorstatus>

</returnsms>

1：用戶名或密碼不能爲空

2：用戶名或密碼錯誤

3：該用戶不容許查看狀態報告

4：參數不正確

第五章 上行接口

5.1 請求地址

請求地址是客戶接口程序調用的時候請求的url地址，採用的是http post接口，地址是

http:// 120.26.59.83:8888/callApi.aspx

入口地址通常不會發生變化，當發生變化的時候，會通知接口用戶

5.2參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號，由系統管理員
password	賬號密碼	用戶帳號對應的密碼
action	任務名稱	設置爲固定的：query

例如：

action=query&userid=12&account=帳號&password=密碼

5.3返回值

<?xml version="1.0" encoding="utf-8" ?> 

<returnsms>

<callbox>

<mobile>15023239810</mobile>-------------對應的手機號碼

<taskid>1212</taskid>-------------同一批任務ID

<content>你好，我不須要</content>---------上行內容

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收時間

</callbox>

<callbox>

<mobile>15023239811</mobile>

<taskid>1212</taskid>

<content>你好，本次活動路線是怎麼的</content>

<receivetime>2011-12-02 22:12:11</receivetime>

</callbox>

</returnsms>

5.4錯誤返回值——回覆請求錯誤返回格式及對應值

<?xml version="1.0" encoding="utf-8" ?> 

<returnsms>

<errorstatus>

<error>1</error>-------------錯誤碼

<remark>用戶名或密碼不能爲空</remark>-------------錯誤描述

</errorstatus>

</returnsms>

1：用戶名或密碼不能爲空

2：用戶名或密碼錯誤

3：該用戶不容許查看狀態報告

4：參數不正確