宽乐通信web service接口说明书v1.1-短信

《宽乐通信web service接口说明书v1.1-短信》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、宽乐通信WebService接口说明书V1.1（短信部分）中国电信股份有限公司广州研究院宽乐通信WebService接口说明书（短信部分）摘要：本文档主要描述宽乐通信对第三方服务器开放收发短信业务能力的WebService接口，对接口格式和相应的参数给出了详细的描述。1总述宽乐系统（UC）通过WebService接口对外提供CTD(点击拨号)、CTC（点击会议）、SMS(收发短信)等业务能力。1.1宽乐帐号说明宽乐系统分配给第三方服务器2种用户号码，Web注册访问用户（可以用于注册回调地址，可以发送短信等操作），Web

2、访问用户（不可以注册回调地址，对应的注册访问用户注册后，可以发送短信等操作）。补充说明：Web访问用户在哪个应用发送短信，就要在该应用下接受短信。第三方服务器与宽乐WebService服务器互相开放WebService接口，互为服务器和客户端，接口符合本文定义。注意无论第三方服务器在公网或者私网内，都需要向宽乐WebService服务器提供WebService服务接口并能够访问宽乐的WebService服务。1.2接口总体说明宽乐提供的短信相关的WebService接口：1）注册接口：RegisterURL:http:

3、//202.105.212.146:8080/jboss-net/services/Register2）发送短信：SendSMSURL:http://202.105.212.146:8080/jboss-net/services/SendSMS以上接口都需要客户端API鉴权，访问WebService时请添加用户名，密码(test/test)。第三方必须提供WebService回调接口：接口名：由第三方给出方法：NotifyStatus、RecvSMS、EchoOfSendSMSURL：由第三方给出下表列出宽乐系统定义的

4、WebService（短信相关）请求和事件报告所使用的接口方法：接口请求和事件方法（函数）方向注册接口获取随机数请求getRandom3rdServeràUCPortal注册接口注册回调地址请求setCallBackAddr3rdServeràUCPortal回调地址更改报告NotifyStatusUCPortalà3rdServer收发短信发送短信请求sendSMS3rdServeràUCPortal发送短信结果报告NotifyStatusUCPortalà3rdServer发送短信回执EchoOfSendSMSUC

5、Portalà3rdServer接收短信请求RecvSMSUCPortalà3rdServer1.1收发短信流程1.1.1注册注意：第三方应用启动后，只需要调用一次该接口获得连接id即可，后续所有要用到connID的地方都可以用该值，不需要每次发送短信都注册。(1)第三方服务器调用WebService服务器的getRandom获取校验用的随机数。(2)第三方服务器用随机数与登录密码加密后，向WebService服务器发起注册回调地址请求setCallBackAddr，该请求携带回调地址参数指明第三方服务器对UC开放的W

6、ebService接口的IP地址、URL和端口。UC对帐号密码鉴权通过后注册该帐号及对应的回调服务信息，生成一个连接id返回给第三方服务器，该连接id在第三方服务器后续的请求中携带。一个帐号只能创建一个连接，最新的注册将使以前注册的回调地址信息失效。1.1.2发送短信(1)第三方服务器重新调用WebService服务器的getRandom获取校验用的随机数，并用该随机数加密sendSMS接口调用的UC密码。(2)第三方服务器调用WebService服务器的发送短信请求sendSMS接口。(3)WebService服务器

7、把短信请求提交给AS。(4)如果鉴权成功，AS把短信提交到短信中心。(5)AS通知WebService服务器发送成功。(6)WebService服务器通过调用回调事件接口NotifyStatus向第三方服务器上报发送短信状态。(1)被叫接收到短信，WebService服务器通知AS短信回执。(2)AS计费，落话单。(3)AS通知WebService服务器第三方收到回执(4)WebService服务器通过调用发送短信回执EchoOfSendSMS接口向第三方服务器通知被叫接收短信状态。短信发送流程如下：1.1.1接收短信

8、注意：宽乐帐号要能接收到短信，需要Web注册访问账号已经注册过（提交了回调地址）。(1)宽乐接收短信时，WebService服务器通过调用接收短信接口RecvSMS向第三方服务器通知接收短信。1接口定义以下可选项，可以填空字符串””。1.1注册接口1.1.1获取随机数·接口说明：第三方服务器通过该接口获取对后续请求加密的随机数。每