宽乐通信WebService接口说明书V1.1—短信.docVIP

宽乐通信Web Service接口说明书V1.1（短信部分） 中国电信股份有限公司广州研究院 宽乐通信 Web Service接口说明书（短信部分） 摘要：本文档主要描述宽乐通信对第三方服务器开放收发短信业务能力的Web Service接口，对接口格式和相应的参数给出了详细的描述。 总述 宽乐系统（UC）通过Web Service接口对外提供CTD(点击拨号)、CTC（点击会议）、SMS(收发短信)等业务能力。 宽乐帐号说明 宽乐系统分配给第三方服务器2种用户号码 ，Web注册访问用户（可以用于注册回调地址，可以发送短信等操作），Web访问用户（不可以注册回调地址，对应的注册访问用户注册后，可以发送短信等操作）。 补充说明：Web访问用户在哪个应用发送短信，就要在该应用下接受短信。 第三方服务器与宽乐Web Service服务器互相开放Web Service接口，互为服务器和客户端，接口符合本文定义。注意无论第三方服务器在公网或者私网内，都需要向宽乐Web Service服务器提供Web Service服务接口并能够访问宽乐的Web Service服务。 接口总体说明 宽乐提供的短信相关的Web Service接口： 注册接口：Register URL:  HYPERLINK 46:8080/jboss-net/services/Register 46:8080/jboss-net/services/Register 发送短信：SendSMS URL: HYPERLINK 46:8080/jboss-net/services/SendSMS 46:8080/jboss-net/services/SendSMS 以上接口都需要客户端API鉴权，访问WebService时请添加用户名，密码(test/test)。 第三方必须提供WebService回调接口： 接口名：由第三方给出 方法：NotifyStatus、RecvSMS、EchoOfSendSMS URL：由第三方给出 下表列出宽乐系统定义的Web Service（短信相关）请求和事件报告所使用的接口方法： 接口请求和事件方法（函数）方向注册接口获取随机数请求getRandom3rd Server ? UC Portal注册接口注册回调地址请求setCallBackAddr3rd Server ? UC Portal回调地址更改报告NotifyStatusUC Portal ? 3rd Server收发短信发送短信请求sendSMS3rd Server ? UC Portal发送短信结果报告NotifyStatusUC Portal ? 3rd Server发送短信回执EchoOfSendSMSUC Portal ? 3rd Server接收短信请求RecvSMSUC Portal ? 3rd Server收发短信流程 注册 注意：第三方应用启动后，只需要调用一次该接口获得连接id即可，后续所有要用到connID的地方都可以用该值，不需要每次发送短信都注册。 第三方服务器调用Web Service服务器的getRandom获取校验用的随机数。 第三方服务器用随机数与登录密码加密后，向Web Service服务器发起注册回调地址请求setCallBackAddr，该请求携带回调地址参数指明第三方服务器对UC开放的WebService接口的IP地址、URL和端口。UC对帐号密码鉴权通过后注册该帐号及对应的回调服务信息，生成一个连接id返回给第三方服务器，该连接id在第三方服务器后续的请求中携带。一个帐号只能创建一个连接，必威体育精装版的注册将使以前注册的回调地址信息失效。 发送短信 第三方服务器重新调用Web Service服务器的getRandom获取校验用的随机数，并用该随机数加密sendSMS接口调用的UC密码。 第三方服务器调用Web Service服务器的发送短信请求sendSMS接口。 Web Service服务器把短信请求提交给AS。 如果鉴权成功，AS把短信提交到短信中心。 AS通知Web Service服务器发送成功。 Web Service服务器通过调用回调事件接口NotifyStatus向第三方服务器上报发送短信状态。 被叫接收到短信，Web Service服务器通知AS短信回执。 AS计费，落话单。 AS通知Web Service服务器第三方收到回执 Web Service服务器通过调用发送短信回执EchoOfSendSMS接口向第三方服务器通知被叫接收短信状态。 短信发送流程如下： 接收短信 注意：宽乐帐号要能接收到短信，需要Web注册访问账号已