0759直连接口WebService协议V1.3

2.1发送短信接口（sendSMS）这是旧的2.2发送短信任务接口（sendTask）这是新的用这个一个任务最大发送数5万，同样内容如果接收号码数量少的请在页面发送，在接口上不要分开几个任务发送，造成浪费资源商信通接口WebService协议（版本：1.3）（密级：）天讯瑞达通信技术有限公司2011年08月项目名称/代码：商信通平台版本：1.3状态：所有人：天讯瑞达通信技术有限公司作者/创建时间：批准人/批准时间：文档更改历史记录序号主要更改内容版本号更改人更改时间1创建文档1.0郑亚川2010.05.072修改部分参数1.1郑亚川2010.11.103增加用户信息查询1.2郑亚川2010.12.204增加发送任务接口1.3郑亚川2011.08.046概述本文档描述商信通（SMSServer）对外提供能力的方式和接口描述，供能力调用者开发所用。1.1.能力调用方式SMSServer对业务能力调用者如无特殊说明，主要采用通过WebService的方式进行同步调用，其他方式调用将会在接口中说明。对接口提供的实现方式：SMSServer提供短信发送接口和查询接口供能力调用者定期轮询。1.2.SXTServer主要短信接口SMSServer主要短信接口：1）同步的发送接口，能力调用者向SMSServer发送短信请求；2）同步的回执集接口，能力调用者轮询SMSServer，看短信回执是否已经可查到，群发短信的回执是以集合的方式返回；3）同步的接收上行短信接口，能力调用者轮询SMSServer，是否收到新的上行短信。2.能力接口说明在能力调用者和SMSServer之间的接口内容，主要包含三方面数据：1）能力调用者数据，CII（CapabilityInvokerIdentity），主要是SMSServer对能力调用者的认证鉴权使用；2）企业用户数据，BUI（BusinessUserIdentity），主要是为Scape提供完整记录用户使用能力日志的功能；3）有效载荷，Payload，每一种能力需要的用户有效输入。用户数据能力调用者数据（CII）企业用户数据（BUI）有效载荷（PayLoad）能力调用者数据，CII的数据结构：CII（CapabilityInvokerIdentity）字段名称说明数据类型是否可空长度account帐号，由SXTServer分配。StringN≤18password密码StringN≤18extendField扩展字段(置空)StringY≤18timestamptimestamp(时间戳)为18位数字组成的字符串，前13位为发起请求或应答时间的13位long类型值（1970年1月1日起直至当前时间的以毫秒为单位的时间间隔的值），后5位为随机数。(置空)StringY18hashcode=md5(Account+Timestamp+Password)，account和timestamp为上述字段，password为account的密码。(置空)StringY32企业用户数据(非必要)，BUI的数据结构如下：BUI（BusinessUserIdentity）字段名称说明数据类型是否可空长度id企业客户帐号在商企平台的唯一ID，即bnetId(置空)StringY≤18account企业客户下的用户帐号(置空)StringY18(注：Payload有效载荷数据在能力接口中进行详细说明。)客户端服务端发送短信(sendSMS)查询上行短信(checkReceivedSMS)查询回执集(queryReturnReceiptAggre)查询用户信息(queryUserInfo)提交任务(sendTask)2.1发送短信接口（sendSMS）函数格式：CTCapResultsendSMS（CIIcii,BUIbui,SMSPayloadsmsPayload）调用者：客户端被调用者：服务端2.1.1.请求参数请求参数字段名称说明数据类型是否可空长度cii能力调用者信息CIINbui企业用户数据(非必要)BUIYsmsPayload发送短信有效载荷SMSPayloadNSMSPayload数据结构：SMSPayload字段名称说明数据类型是否可空长度content短信内容StringN≤1024contentFormat短信内容编码，UTF-8编码格式。（置空）StringYneedFeedback短信是否需要回执0-不需要回执1-需要回执StringNpassword发送端口号的密码（置空）StringY≤30receivers接收者号码数组String[]Nareacode接收者号码的归属地（置空）StringYsender发送端口号(置空)StringY≤30补充说明：接收号码组最多200个，建议50个以下2.1.2.应答参数应答参数字段名称说明数据类型是否可空长度ctCapResult返回的结果CTCapResultNCTCapResult数据结构：CTCapResult字段名称说明数据类型是否可空长度sessionId返回的唯一的会话idStringN≤32resultCode返回的结果代码，见3.1结果代码描述StringNdesc对resultCode结果的补充说明StringY≤2552.2发送短信任务接口（sendTask）函数格式：CTCapResultsendTask（CIIcii,BUIbui,TaskPayloadtaskPayload）调用者：客户端被调用者：服务端2.2.1.请求参数请求参数字段名称说明数据类型是否可空长度cii能力调用者信息CIINbui企业用户数据(非必要)BUIYsmsPayload发送短信有效载荷SMSPayloadNSMSPayload数据结构：SMSPayload字段名称说明数据类型是否可空长度taskTitle任务标题StringN≤100content短信内容StringN≤1024receivers接收者号码数组String[]NscheTime定时时间（如果sendMethod为1，不可为空）格式:yyyy-MM-ddhh:mm:ssStringYsendMethod是否定时发送0-非定时发送1-定时发送StringN=1补充说明：接收号码组最多10000个2.2.2.应答参数应答参数字段名称说明数据类型是否可空长度ctCapResult返回的结果CTCapResultNCTCapResult数据结构：CTCapResult字段名称说明数据类型是否可空长度sessionId返回的唯一的会话idStringN≤32resultCode返回的结果代码，见3.1结果代码描述StringNdesc对resultCode结果的补充说明StringY≤2552.3查询上行短信接口（checkReceivedSMS）函数格式：SMSResultcheckReceivedSMS（CIIcii,Stringbusid）调用者：客户端被调用者：服务端2.3.1.请求参数请求参数字段名称说明数据类型是否可空长度cii能力调用者信息CIINbusid要收取某一业务短信的代码StringY≤202.3.2.应答参数应答参数字段名称说明数据类型是否可空长度smsResult返回的回执结果SMSResultNSMSResult数据结构：应答参数字段名称说明数据类型是否可空长度resultCode返回的结果代码，见3.1结果代码描述StringNmessageCount接收到的短信条数IntNsmsMessages短信数组SMSMessage[]YSMSMessage数据结构字段名称说明数据是否可长度类型空smsid短信序号intNsender短信发送者StringN≤30receiver短信接收者：厂家或者业务平台StringN≤10content短信内容StringN≤140contentFormat短信内容编码，UTF-8编码格式。StringNreceiveTime短信上行时间StringNbusid业务码：上行短信所属业务的代码StringN22.4查询回执集合接口（queryReturnReceiptAggre）（注：短信回执只保留一天，调用接口间隔不少于1秒钟）函数格式：SMSResultAggrequeryReturnReceiptAggre（CIIcii,Stringsender）调用者：客户端被调用者：服务端2.4.1.请求参数请求参数字段名称说明数据类型是否可空长度cii能力调用者信息CIINsender发送端口号StringY≤302.4.2.应答参数应答参数字段名称说明数据是否可长度类型空smsResultAggre返回的回执集的结果SMSResultAggreNSMSResultAggre数据结构：应答参数字段名称说明数据类型是否可空长度resultCode调用接口结果,见3.1结果代码描述StringNmessageCount短信回执条数intNsmsReceipts短信回执数组SMSReceipt[]YSMSReceipt数据结构字段名称说明数据类型是否可空长度smsid短信回执序号StringNreceiversessionId中的接收者StringN≤20sessionId每天发送短信的IDStringN≤32receiveTime回执接收时间StringNsmsState短信的状态StringN≤102.5查询用户信息（queryUserInfo）函数格式：userInfoResultqueryUserInfo（CIIcii）调用者：客户端被调用者：服务端2.5.1.请求参数请求参数字段名称说明数据是否可空长度类型cii能力调用者信息CIIN2.5.2.应答参数应答参数字段名称说明数据类型是否可空长度userInfoResult返回的回执结果userInfoResultNuserInfoResult数据结构：应答参数字段名称说明数据类型是否可空长度resultCode返回的结果代码，见3.1结果代码描述StringNuserCount用户数量IntNuserInfo用户信息数组userInfo[]YuserInfo数据结构字段名称说明数据类型是否可空长度userId用户名StringNsmsCount剩余短信数量StringN3.附件3.1.能力调用返回的结果代码结果代码代码描述0操作成功-1操作失败00010000未知错误00010001用户提交参数为空00020005用户验证数据或者短信数据为空00040002用户查询回执连接达到最大值，返回系统繁忙00020001用户名或密码不正确10010041号码超过最大数量10010032内容错误,包含关键字10010033用户提交信息错误,号码被全部过滤10010035下行号码错误或者没有发送号码00020003用户余额不足以扣费3.2.XML包格式3.2.1.sendSMSsoapenv:Envelopexmlns:soapenv=:xsd=:xsi=:mul===:sendSMSmul:in0mes:accounttest/mes:accountmes:extendField/mes:extendFieldmes:hashCode/mes:ha