商信通新接口WebService协议V1.0.doc

修订历史 时间 版本号 修订内容 修订人 2010.05.07 1.0 郑亚川 1. 概述 本文档描述商信通（SMSServer）对外提供能力的方式和接口描述，供能力调用者开发所用。 1.1. 能力调用方式 SMSServer对业务能力调用者如无特殊说明，主要采用通过WebService的方式进行同步调用，其他方式调用将会在接口中说明。对接口提供的实现方式：SMSServer提供短信发送接口和查询接口供能力调用者定期轮询。 1.2.HbServer主要短信接口 SMSServer主要短信接口： 1）同步的发送接口，能力调用者向SMSServer发送短信请求； 2）同步的回执集接口，能力调用者轮询SMSServer，看短信回执是否已经可查到，群发短信的回执是以集合的方式返回； 3）同步的接收上行短信接口，能力调用者轮询SMSServer，是否收到新的上行短信。 2. 能力接口说明 在能力调用者和SMSServer之间的接口内容，主要包含三方面数据：1）能力调用者数据，CII（Capability Invoker Identity），主要是SMSServer对能力调用者的认证鉴权使用；2）企业用户数据，BUI（Business User Identity），主要是为Scape提供完整记录用户使用能力日志的功能；3）有效载荷，Payload，每一种能力需要的用户有效输入。 能力调用者数据，CII的数据结构： CII（Capability Invoker Identity） 字段名称 说明 数据 类型 是否可空 长度 account 帐号，由HbServer分配。 String N ≤18 password 密码 String N ≤18 extendField 扩展字段 String Y ≤18 timestamp timestamp(时间戳)为18位数字组成的字符串，前13位为发起请求或应答时间的13位long类型值（1970年1月1日起直至当前时间的以毫秒为单位的时间间隔的值），后5位为随机数。 String Y 18 hashcode =md5(Account+Timestamp+Password)，account和timestamp为上述字段，password为account的密码。 String Y 32 企业用户数据(非必要)，BUI的数据结构如下： BUI（Business User Identity） 字段名称 说明 数据 类型 是否可空 长度 id 企业客户帐号在商企平台的唯一ID，即bnetId String Y ≤18 account 企业客户下的用户帐号 String Y 18 (注：Payload有效载荷数据在能力接口中进行详细说明。) 2.1. 发送短信接口（sendSMS） 函数格式：CTCapResult sendSMS（CII cii,BUI bui,SMSPayload smsPayload） 调用者：能力调用者 被调用者：HbServer 2.1.1. 请求参数 请求参数 字段名称 说明 数据 类型 是否可空 长度 cii 能力调用者信息 CII N bui 企业用户数据(非必要) BUI Y smsPayload 发送短信有效载荷 SMSPayload N SMSPayload数据结构： SMSPayload 字段名称 说明 数据 类型 是否可空 长度 sender 发送端口号(当接收号码为本网号码时使用) String Y ≤30 password 发送端口号的密码 置空 String Y ≤30 areacode 接收者号码的归属地(用于选取宽乐号码发送异网短信) 置空 String Y receivers 接收者号码数组 String[] N content 短信内容 String N ≤1024 contentFormat 短信内容编码，UTF-8编码格式。 String Y needFeedback 短信是否需要回执 0-不需要回执 1-需要回执 String N 补充说明：areacode字段，用于标记接收号码所属地区。 Receivers只支持一个小灵通或C网号码。 Receivers字段支持最多设定10个异网手机号码（本网号码只支持1个），号码之间以半角的逗号分隔。 2.1.2. 应答参数 应答参数 字段名称 说明 数据 类型 是否可空 长度 ctCapResult 返回的结果 CTCapResult N CTCapResult数据结构： CTCapResult 字段名称 说明 数据 类型 是否可空 长度 sessionId 返回的唯一的会话i