0759商信通接口WebService协议V1.3

商信通接口 WebService协议

（版本：1.3）

（密级：）

天讯瑞达通信技术有限公司

2011年08月

1. 概述

本文档描述商信通（SMSServer）对外提供能力的方式和接口描述，供能力调用者开发所用。

1.1. 能力调用方式

SMSServer对业务能力调用者如无特殊说明，主要采用通过WebService的方式进行同步调用，其他方式调用将会在接口中说明。对接口提供的实现方式：SMSServer提供短信发送接口和查询接口供能力调用者定期轮询。

1.2.SXTServer主要短信接口

SMSServer主要短信接口：

1）同步的发送接口，能力调用者向SMSServer发送短信请求；

2）同步的回执集接口，能力调用者轮询SMSServer，看短信回执是否已经可查到，群发短信的回执是以集合的方式返回；

3）同步的接收上行短信接口，能力调用者轮询SMSServer，是否收到新的上行短信。

2. 能力接口说明

在能力调用者和SMSServer之间的接口内容，主要包含三方面数据：1）能力调用者数据，CII（Capability Invoker Identity），主要是SMSServer对能力调用者的认证鉴权使用；2）企业用户数据，BUI（Business User Identity），主要是为Scape提供完整记录用户使用能力日志的功能；3）有效载荷，Payload，每一种能力需要的用户有效输入。

能力调用者数据，CII的数据结构：

企业用户数据(非必要)，BUI的数据结构如下：

(注：Payload有效载荷数据在能力接口中进行详细说明。)

2.1  发送短信接口（sendSMS）

函数格式：CTCapResult sendSMS（CII cii,BUI bui,SMSPayload smsPayload）

调用者：客户端

被调用者：服务端

2.1.1.  请求参数

SMSPayload数据结构：

2.1.2.  应答参数

CTCapResult数据结构：

2.2  发送短信任务接口（sendTask）

函数格式：CTCapResult sendTask（CII cii,BUI bui,TaskPayload taskPayload）

调用者：客户端

被调用者：服务端

2.2.1.  请求参数

SMSPayload数据结构：

2.2.2.  应答参数

CTCapResult数据结构：

2.3  查询上行短信接口（checkReceivedSMS）

函数格式：SMSResult  checkReceivedSMS（CII cii,String busid）

调用者：客户端

被调用者： 服务端

2.3.1.  请求参数

2.3.2.  应答参数

SMSResult数据结构：

SMSMessage数据结构

2.4  查询回执集合接口（queryReturnReceiptAggre）

（注：短信回执只保留一天，调用接口间隔不少于1秒钟）

函数格式：SMSResultAggre  queryReturnReceiptAggre（CII cii,String sender）

调用者：客户端

被调用者： 服务端

2.4.1.  请求参数

2.4.2.  应答参数

SMSResultAggre数据结构：

SMSReceipt数据结构

2.5  查询用户信息（queryUserInfo）

函数格式：userInfoResult  queryUserInfo（CII cii）

调用者：客户端

被调用者： 服务端

2.5.1.  请求参数

2.5.2.  应答参数

userInfoResult数据结构：

userInfo数据结构

3. 附件

3.1. 能力调用返回的结果代码

3.2. XML包格式

3.2.1.  sendSMS

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mul="http://www.muleumo.org" xmlns:mes="http://message.scape.gsta.com" xmlns:sms="http://sms.cap.scape.gsta.com">

       <soapenv:Body>

              <mul:sendSMS>

                     <mul:in0>

                            <mes:account>test</mes:account>

                            <mes:extendField></mes:extendField>

                            <mes:hashCode></mes:hashCode>

                            <mes:password>123456</mes:password>

                            <mes:timestamp></mes:timestamp>

                     </mul:in0>

                     <mul:in1>

                            <mes:account></mes:account>

                            <mes:id></mes:id>

                     </mul:in1>

                     <mul:in2>

                            <sms:content>sendSMStest</sms:content>

                            <sms:contentFormat>1</sms:contentFormat>

                            <sms:needFeedback>1</sms:needFeedback>

                            <sms:password></sms:password>

                            <sms:receivers>

                                   <mul:string>18900000000</mul:string>

                                   <mul:string>13300000000</mul:string>

                            </sms:receivers>

                            <sms:areacode></sms:areacode>

                            <sms:sender></sms:sender>

                     </mul:in2>

              </mul:sendSMS>

       </soapenv:Body>

</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

       <soapenv:Body>

              <ns4:sendSMSResponse xmlns:ns4="http://www.muleumo.org">

                     <ns4:out>

                            <ns3:desc xmlns:ns3="http://cap.scape.gsta.com">&#x6210;&#x529F;</ns3:desc>

                            <ns3:resultCode xmlns:ns3="http://cap.scape.gsta.com">0</ns3:resultCode>

                            <ns3:sessionId xmlns:ns3="http://cap.scape.gsta.com">635159</ns3:sessionId>

                     </ns4:out>

              </ns4:sendSMSResponse>

       </soapenv:Body>

</soapenv:Envelope>

3.2.2.  sendTask

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mul="http://www.muleumo.org" xmlns:mes="http://message.scape.gsta.com" xmlns:sms="http://sms.cap.scape.gsta.com">

    <soapenv:Body>

        <mul:sendTask>

            <mul:in0>

                <mes:account>test</mes:account>

                <mes:extendField></mes:extendField>

                <mes:hashCode></mes:hashCode>

                <mes:password>123456</mes:password>

                <mes:timestamp></mes:timestamp>

            </mul:in0>

            <mul:in1>

                <mes:account></mes:account>

                <mes:id></mes:id>

            </mul:in1>

            <mul:in2>

                <sms:taskTitle>task1</sms:taskTitle>

                <sms:content>sendtask_test</sms:content>

                <sms:scheTime>2011-8-03 17:09:00</sms:scheTime>

                <sms:sendMethod>1</sms:sendMethod>

                <sms:receivers>

                    <mul:string>18900000000</mul:string>

                    <mul:string>13300000000</mul:string>

                </sms:receivers>

            </mul:in2>

        </mul:sendTask>

    </soapenv:Body>

</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

    <soapenv:Body>

        <ns4:sendTaskResponse xmlns:ns4="http://www.muleumo.org">

            <ns4:out>

                <ns3:desc xmlns:ns3="http://cap.scape.gsta.com">&#x6210;&#x529F;</ns3:desc>

                <ns3:resultCode xmlns:ns3="http://cap.scape.gsta.com">0</ns3:resultCode>

                <ns3:sessionId xmlns:ns3="http://cap.scape.gsta.com">2365</ns3:sessionId>

            </ns4:out>

        </ns4:sendTaskResponse>

    </soapenv:Body>

</soapenv:Envelope>

3.2.3.  checkReceivedSMS

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mul="http://www.muleumo.org" xmlns:mes="http://message.scape.gsta.com">

       <soapenv:Body>

              <mul:checkReceivedSMS>

                     <mul:in0>

                            <mes:account>test</mes:account>

                            <mes:extendField></mes:extendField>

                            <mes:hashCode></mes:hashCode>

                            <mes:password>123456</mes:password>

                            <mes:timestamp></mes:timestamp>

                     </mul:in0>

                     <mul:in1></mul:in1>

              </mul:checkReceivedSMS>

       </soapenv:Body>

</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

       <soapenv:Body>

              <ns4:checkReceivedSMSResponse xmlns:ns4="http://www.muleumo.org">

                     <ns4:out>

                            <ns2:messageCount xmlns:ns2="http://sms.cap.scape.gsta.com">1</ns2:messageCount>

                            <ns2:resultCode xmlns:ns2="http://sms.cap.scape.gsta.com">0</ns2:resultCode>

                            <smsMessages xmlns="http://sms.cap.scape.gsta.com">

                                   <SMSMessage>

                                          <smsid>11760</smsid>

                                          <content>Recv</content>

                                          <receiveTime>20110804095326</receiveTime>

                                          <receiver>075487150536</receiver>

                                          <sender>18900000000</sender>

                                   </SMSMessage>

                            </smsMessages>

                     </ns4:out>

              </ns4:checkReceivedSMSResponse>

       </soapenv:Body>

</soapenv:Envelope>

3.2.4.  queryReturnReceiptAggre

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mul="http://www.muleumo.org" xmlns:mes="http://message.scape.gsta.com">

       <soapenv:Body>

              <mul:queryReturnReceiptAggre>

                     <mul:in0>

                            <mes:account>test</mes:account>

                            <mes:extendField></mes:extendField>

                            <mes:hashCode></mes:hashCode>

                            <mes:password>123456</mes:password>

                            <mes:timestamp></mes:timestamp>

                     </mul:in0>

                     <mul:in1></mul:in1>

              </mul:queryReturnReceiptAggre>

       </soapenv:Body>

</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

       <soapenv:Body>

              <ns4:queryReturnReceiptAggreResponse xmlns:ns4="http://www.muleumo.org">

                     <ns4:out>

                            <ns2:messageCount xmlns:ns2="http://sms.cap.scape.gsta.com">2</ns2:messageCount>

                            <ns2:resultCode xmlns:ns2="http://sms.cap.scape.gsta.com">0</ns2:resultCode>

                            <smsReceipts xmlns="http://sms.cap.scape.gsta.com">

                                   <SMSReceipt>

                                          <smsid>1</smsid>

                                          <receiver>18900000000</receiver>

                                          <sessionId>2365</sessionId>

                                          <receiveTime>20110804091502</receiveTime>

                                          <smsState>fail</smsState>

                                   </SMSReceipt>

                                   <SMSReceipt>

                                          <smsid>1</smsid>

                                          <receiver>13300000000</receiver>

                                          <sessionId>2365</sessionId>

                                          <receiveTime>20110804091502</receiveTime>

                                          <smsState>fail</smsState>

                                   </SMSReceipt>

                            </smsReceipts>

                     </ns4:out>

              </ns4:queryReturnReceiptAggreResponse>

       </soapenv:Body>

</soapenv:Envelope>

3.2.5.  queryUserInfo

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mul="http://www.muleumo.org" xmlns:mes="http://message.scape.gsta.com">

       <soapenv:Body>

              <mul:queryUserInfo>

                     <mul:in0>

                            <mes:account>test</mes:account>

                            <mes:extendField></mes:extendField>

                            <mes:hashCode></mes:hashCode>

                            <mes:password>123456</mes:password>

                            <mes:timestamp></mes:timestamp>

                     </mul:in0>

                     <mul:in1></mul:in1>

              </mul:queryUserInfo>

       </soapenv:Body>

</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

       <soapenv:Body>

              <ns4:queryUserInfoResponse xmlns:ns4="http://www.muleumo.org">

                     <ns4:out>

                            <ns2:userCount xmlns:ns2="http://sms.cap.scape.gsta.com">1</ns2:userCount>

                            <ns2:resultCode xmlns:ns2="http://sms.cap.scape.gsta.com">0</ns2:resultCode>

                            <userInfo xmlns="http://sms.cap.scape.gsta.com">

                                   <UserInfo>

                                          <userId>test</userId>

                                          <smsCount>270</smsCount>

                                   </UserInfo>

                            </userInfo>

                     </ns4:out>

              </ns4:queryUserInfoResponse>

       </soapenv:Body>

</soapenv:Envelope>