深圳电信宽乐通信业务接口规范.doc

深圳电信宽乐通信业务接口规范 (修订版 2.0) 深圳电信分公司 增值业务部 1、概述 3 1.1 接口原则 3 1.2 目标 3 1.3 接口的调用方式 3 1.4 帐号申请 4 2、卓越通信向第三方提供的接口信息描述 4 2.1 总述 4 2.2 接口定义说明 7 2.2.1 注册接口 7 2.2.2 CTD 相关接口 9 2.2.3 CTC相关接口 12 2.2.4 SendSMS短信相关接口 18 2.2.5 第三方服务器需要实现通用回调函数 20 3、加密规则 24 4、通用失败码 24  概述 本文档主要描述了深圳电信宽乐通信接口平台对第三方合作商开放业务能力的WebService接口和使用规范。 经运营商分配给使用账号后，第三方合作商能够使用宽乐通信业务平台的通信服务资源，主要有点击拨号、短信收发、多方会议、网络传真功能等服务。 接口原则 第三方软件商在进行开发，使用相关接口时，须遵循以下原则： 严格按照接口规范文档中所定义的规范格式，进行数据处理 对于新增通信服务，将由深圳电信制定标准接口，并更新接口协议，通知第三方各软件合作商； 目标 宽乐通信与第三方软件商接口功能达到如下目标： 接口简单便于操作，并能够兼容接口以后扩充； 提供对外的开放性，能够具备接入认证功能，保证系统的安全性； 接口标准对外可靠和高效； 提供解决故障的手段和流程机制，由于面向客户提供的服务将由传统方式中的运营商一种角色，转变成软件合作商和运营商多个角色，因此须提供高效的机制，能够定位故障和解决。 接口的调用方式 实现方式：调用Web Service服务，遵循标准的soap协议。 第三方软件产品与宽乐通信业务平台互为客户端和服务端。 第三方软件产品按照各操作规范和文档格式进行数据填充，主动调用宽乐通信业务平台提供的相关Web Service服务。平台根据应用请求注册的回调处理地址，异步返回回调处理。 帐号申请 凡需使用深圳电信宽乐通信相关通信资源的的第三方合作商，需至深圳电信申请相应的宽乐通信帐号。该宽乐通信帐号具备相应的业务使用能力。 宽乐通信向第三方提供的接口信息描述 总述 第三方合作商应用服务器与宽乐通信业务平台互相开放WebService接口，互为服务端和客户端，接口符合本文定义。无论第三方应用服务器通过公网或者专线接入宽乐通信业务平台，都需要宽乐通信业务平台提供注册回调地址，以便宽乐通信业务平台能够异步推送结果响应和相关服务结果，同时需保证第三方应用服务器能够正常访问宽乐通信业务平台的WebService服务。 宽乐通信业务平台提供5个WebService 接口： 注册接口：Register URL: 46:8080/jboss-net/services/Register b、CTD 接口：CTDCall URL:http://IP:port/ axis /services/CTDCall c、CTC 接口:CTCCall URL:http://IP:port/ axis /services/CTCCall d、收发短信：SendSMS URL: 46:8080/jboss-net/services/SendSMS 方法包括：sendSMS e、FAX接口：FAXServ 请参见《网络传真接口规范文档》 客户端在进行访问以上接口服务时均需进行鉴权，需添加用户名，密码。鉴权信息如下： 用户名：test 密码：test 第三方必须提供WebService 回调地址，主要含如下内容： 接口：Callback 方法：notifyStatus URL：由第三方软件合作商给出。 下表列出宽乐通信接口平台定义的全部WebService请求和事件报告所使用的接口方法： 接口 请求和事件 方法（函数） 方向（3rd Server为第三方应用平台、KLTX为宽乐通信业务平台） 注册接口 获取随机数请求 getRandom 3rd Server → KLTX 注册回调地址请求 setCallBackAddr 3rd Server → KLTX 回调地址更改报告 notifyStatus KLTX → 3rd Server CTD接口 发起CTD呼叫请求 dialCall 3rd Server → KLTX 发起CTD呼叫结果报告 notifyStatus KLTX→ 3rd Server 终止CTD呼叫请求 releaseCall 3rd Server → KLTX 呼叫终止结果报告 notifyStatus KLTX→ 3rd Server 查询CTD呼叫请求 getCallStatus 3rd Server → KLTX CTC接口 发起会议请求 createConf 3rd Server → KLTX