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

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

WebServices

1 接口說明 2

2 發送接口 2

2.1 調用接口 2

2.2 參數說明 2

2.3 請求和響應 3

2.3.1 SOAP 1.2請求 3

2.3.2 SOAP 1.2響應 4

2.3.3 HTTP POST請求 4

2.3.4 HTTP POST響應 4

3 餘額接口 5

3.1 調用接口 5

3.2 參數說明 5

3.3 請求和響應 5

3.3.1 SOAP 1.2請求 6

3.3.2 SOAP 1.2響應 6

3.3.3 HTTP POST請求 7

3.3.4 HTTP POST響應 7

4 狀態報告接口 8

4.1 調用接口 8

4.2 參數說明 8

4.3 請求和響應 8

4.3.1 SOAP 1.2請求 9

4.3.2 SOAP 1.2響應 9

4.3.3 HTTP POST請求 10

4.3.4 HTTP POST響應 10

5 上行回覆接口 11

5.1 調用接口 11

5.2 參數說明 11

5.3 請求和響應 12

5.3.1 SOAP 1.2請求 12

5.3.2 SOAP 1.2響應 13

5.3.3 HTTP POST請求 14

5.3.4 HTTP POST響應 14

接口說明：客戶接口部分提供WebService方式的接口，接口編碼方式採用統一的UTF-8，如需HTTP協議接口，請聯繫客服

1 接口說明

請求地址是客戶接口程序調用時請求的WebService地址，地址是

http:// 120.26.59.83:8888/SmsWebService.asmx?wsdl

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

 

客戶端地址 爲域名或 IP:客戶端端

2 發送接口

2.1 調用接口

 

SendSms(string userid, string account, string password, string mobile, string content, string sendTime, string extno)

 

2.2 參數說明

 

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

2.3 請求和響應

響應爲WsSendResponse，具體定義以下：

元素名稱	含義	說明
ReturnStatus	任務狀態	Success 成功 Faild 失敗
Message	描述	提交成功爲 ok 其餘爲失敗信息的描述
RemainPoint	剩餘短信條數	剩餘短信條數
TaskID	任務ID	每批次任務惟一的ID，用來匹配狀態報告
SuccessCounts	成功條數	成功提交的號碼數

 

2.3.1 SOAP 1.2請求

如下是 SOAP 1.2 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx HTTP/1.1

Host: localhost

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <SendSms xmlns="http://tempuri.org/">

      <userid>string</userid>

      <account>string</account>

      <password>string</password>

      <mobile>string</mobile>

      <content>string</content>

      <sendTime>string</sendTime>

      <extno>string</extno>

    </SendSms>

  </soap12:Body>

</soap12:Envelope>

2.3.2 SOAP 1.2響應

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <SendSmsResponse xmlns="http://tempuri.org/">

      <SendSmsResult>

        <ReturnStatus>string</ReturnStatus>

        <Message>string</Message>

        <RemainPoint>int</RemainPoint>

        <TaskID>int</TaskID>

        <SuccessCounts>int</SuccessCounts>

      </SendSmsResult>

    </SendSmsResponse>

  </soap12:Body>

</soap12:Envelope>

2.3.3 HTTP POST請求

如下是 HTTP POST 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx/SendSms HTTP/1.1

Host: localhost

Content-Type: application/x-www-form-urlencoded

Content-Length: length

 

userid=string&account=string&password=string&mobile=string&content=string&sendTime=string&extno=string

2.3.4 HTTP POST響應

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

 

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

<WsSendResponse xmlns="http://tempuri.org/">

  <ReturnStatus>string</ReturnStatus>

  <Message>string</Message>

  <RemainPoint>int</RemainPoint>

  <TaskID>int</TaskID>

  <SuccessCounts>int</SuccessCounts>

</WsSendResponse>

 

 

3 餘額接口

3.1 調用接口

QueryOverage(string userid, string account, string password)

3.2 參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號
password	賬號密碼	用戶帳號對應的密碼

3.3 請求和響應

響應爲WsOverageResponse，具體定義以下：

元素名稱	含義	說明
ReturnStatus	獲取狀態	Success 成功 Faild 失敗
Message	描述	獲取成功爲 ok 其餘爲失敗信息的描述
PayInfo	付費方式	預付費 後付費
Overage	餘額	剩餘餘額
SendTotal	總條數	總充值條數

 

 

3.3.1 SOAP 1.2請求

如下是 SOAP 1.2 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx HTTP/1.1

Host: localhost

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryOverage xmlns="http://tempuri.org/">

      <userid>string</userid>

      <account>string</account>

      <password>string</password>

    </QueryOverage>

  </soap12:Body>

</soap12:Envelope>

3.3.2 SOAP 1.2響應

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryOverageResponse xmlns="http://tempuri.org/">

      <QueryOverageResult>

        <ReturnStatus>string</ReturnStatus>

        <Message>string</Message>

        <PayInfo>string</PayInfo>

        <Overage>int</Overage>

        <SendTotal>int</SendTotal>

      </QueryOverageResult>

    </QueryOverageResponse>

  </soap12:Body>

</soap12:Envelope>

3.3.3 HTTP POST請求

如下是 HTTP POST 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx/QueryOverage HTTP/1.1

Host: localhost

Content-Type: application/x-www-form-urlencoded

Content-Length: length

 

userid=string&account=string&password=string

3.3.4 HTTP POST響應

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

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

<WsOverageResponse xmlns="http://tempuri.org/">

  <ReturnStatus>string</ReturnStatus>

  <Message>string</Message>

  <PayInfo>string</PayInfo>

  <Overage>int</Overage>

  <SendTotal>int</SendTotal>

</WsOverageResponse>

 

 

4 狀態報告接口

注意：相同的狀態報告，只能獲取一次。

4.1 調用接口

QueryStatus(string userid, string account, string password, string statusNum)

4.2 參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號
password	賬號密碼	用戶帳號對應的密碼
statusNum	每次取得號碼數	必須爲數字，默認4000，可不填 最小10，最大10000

 

4.3 請求和響應

響應爲WsStatusResponse，具體定義以下：

父元素名稱	元素名稱	含義	說明
QueryStatusResult	ReturnStatus	獲取狀態	1 成功 0 暫無狀態報告 其它狀態皆爲失敗，具體失敗緣由見描述
QueryStatusResult	Message	描述	獲取成功爲 ok 其餘爲失敗信息的描述
QueryStatusResult	StatusList	狀態列表	狀態列表
StatusList	WsStatusBox+	狀態容器	後面加號表示一個狀態列表內可由多個容器組合
WsStatusBox	Mobile	手機號碼	接收手機號碼
WsStatusBox	TaskID	任務ID	發送短信時返回的任務ID
WsStatusBox	Status	狀態	10 發送成功 20 發送失敗
WsStatusBox	ReceiveTime	接收時間	手機接收短信時間
WsStatusBox	ErrorCode	發送返回值	由上級通道返回，不一樣的通道返回值可能不一樣，部分通道返回值爲 DELIVRD
WsStatusBox	Extno	子號	即自定義擴展號

 

4.3.1 SOAP 1.2請求

如下是 SOAP 1.2 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx HTTP/1.1

Host: localhost

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryStatus xmlns="http://tempuri.org/">

      <userid>string</userid>

      <account>string</account>

      <password>string</password>

      <statusNum>string</statusNum>

    </QueryStatus>

  </soap12:Body>

</soap12:Envelope>

4.3.2 SOAP 1.2響應

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryStatusResponse xmlns="http://tempuri.org/">

      <QueryStatusResult>

        <ReturnStatus>int</ReturnStatus>

        <Message>string</Message>

        <StatusList>

          <WsStatusBox>

            <Mobile>string</Mobile>

            <TaskID>int</TaskID>

            <Status>int</Status>

            <ReceiveTime>string</ReceiveTime>

            <ErrorCode>string</ErrorCode>

            <Extno>string</Extno>

          </WsStatusBox>

          <WsStatusBox>

            <Mobile>string</Mobile>

            <TaskID>int</TaskID>

            <Status>int</Status>

            <ReceiveTime>string</ReceiveTime>

            <ErrorCode>string</ErrorCode>

            <Extno>string</Extno>

          </WsStatusBox>

        </StatusList>

      </QueryStatusResult>

    </QueryStatusResponse>

  </soap12:Body>

</soap12:Envelope>

4.3.3 HTTP POST請求

如下是 HTTP POST 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx/QueryStatus HTTP/1.1

Host: localhost

Content-Type: application/x-www-form-urlencoded

Content-Length: length

 

userid=string&account=string&password=string&statusNum=string

4.3.4 HTTP POST響應

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

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

<WsStatusResponse xmlns="http://tempuri.org/">

  <ReturnStatus>int</ReturnStatus>

  <Message>string</Message>

  <StatusList>

    <WsStatusBox>

      <Mobile>string</Mobile>

      <TaskID>int</TaskID>

      <Status>int</Status>

      <ReceiveTime>string</ReceiveTime>

      <ErrorCode>string</ErrorCode>

      <Extno>string</Extno>

    </WsStatusBox>

    <WsStatusBox>

      <Mobile>string</Mobile>

      <TaskID>int</TaskID>

      <Status>int</Status>

      <ReceiveTime>string</ReceiveTime>

      <ErrorCode>string</ErrorCode>

      <Extno>string</Extno>

    </WsStatusBox>

  </StatusList>

</WsStatusResponse>

 

 

5 上行回覆接口

注意：相同的上行回覆，只能獲取一次。

 

5.1 調用接口

QueryCall(string userid, string account, string password, string callNum)

5.2 參數說明

參數名稱	含義	說明
userid	企業id	企業ID
account	用戶賬號	用戶賬號
password	賬號密碼	用戶帳號對應的密碼
callNum	每次取得號碼數	必須爲數字，默認500，可不填 最小10，最大10000

 

5.3 請求和響應

響應爲WsCallResponse，具體定義以下：

父元素名稱	元素名稱	含義	說明
QueryCallResult	ReturnStatus	獲取狀態	1 成功 0 暫無上行回覆 其它狀態皆爲失敗，具體失敗緣由見描述
QueryCallResult	Message	描述	獲取成功爲 ok 其餘爲失敗信息的描述
QueryCallResult	CallList	上行列表	上行列表
CallList	WsCallBox+	上行容器	後面加號表示一個上行列表內可由多個容器組合
WsCallBox	Mobile	手機號碼	上行手機號碼
WsCallBox	TaskID	任務ID	發送短信時返回的任務ID，若是是直接上行，這裏可能爲空
WsCallBox	Content	上行內容	上行回覆的內容
WsCallBox	ReceiveTime	接收時間	手機上行短信時間
WsCallBox	Extno	子號	即自定義擴展號

 

5.3.1 SOAP 1.2請求

如下是 SOAP 1.2 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx HTTP/1.1

Host: localhost

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryCall xmlns="http://tempuri.org/">

      <userid>string</userid>

      <account>string</account>

      <password>string</password>

      <callNum>string</callNum>

    </QueryCall>

  </soap12:Body>

</soap12:Envelope>

5.3.2 SOAP 1.2響應

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

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

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <QueryCallResponse xmlns="http://tempuri.org/">

      <QueryCallResult>

        <ReturnStatus>int</ReturnStatus>

        <Message>string</Message>

        <CallList>

          <WsCallBox>

            <Mobile>string</Mobile>

            <TaskID>int</TaskID>

            <Content>string</Content>

            <ReceiveTime>string</ReceiveTime>

            <Extno>string</Extno>

          </WsCallBox>

          <WsCallBox>

            <Mobile>string</Mobile>

            <TaskID>int</TaskID>

            <Content>string</Content>

            <ReceiveTime>string</ReceiveTime>

            <Extno>string</Extno>

          </WsCallBox>

        </CallList>

      </QueryCallResult>

    </QueryCallResponse>

  </soap12:Body>

</soap12:Envelope>

5.3.3 HTTP POST請求

如下是 HTTP POST 請求和響應示例。所顯示的佔位符需替換爲實際值。

POST /clientsite/SmsWebService.asmx/QueryCall HTTP/1.1

Host: localhost

Content-Type: application/x-www-form-urlencoded

Content-Length: length

 

userid=string&account=string&password=string&callNum=string

5.3.4 HTTP POST響應

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

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

<WsCallResponse xmlns="http://tempuri.org/">

  <ReturnStatus>int</ReturnStatus>

  <Message>string</Message>

  <CallList>

    <WsCallBox>

      <Mobile>string</Mobile>

      <TaskID>int</TaskID>

      <Content>string</Content>

      <ReceiveTime>string</ReceiveTime>

      <Extno>string</Extno>

    </WsCallBox>

    <WsCallBox>

      <Mobile>string</Mobile>

      <TaskID>int</TaskID>

      <Content>string</Content>

      <ReceiveTime>string</ReceiveTime>

      <Extno>string</Extno>

    </WsCallBox>

  </CallList>

</WsCallResponse>