宽乐通信Web Service接口说明书V1.1（短信部分）
宽乐通信 Web Service接口说明书（短信部分）
摘要：本文档主要描述宽乐通信对第三方服务器开放收发短信业务能力的Web Service接
口，对接口格式和相应的参数给出了详细的描述。
1 总述
宽乐系统（UC）通过Web Service接口对外提供CTD(点击拨号)、CTC（点击会议）、
SMS(收发短信)等业务能力。
1.1 宽乐帐号说明
宽乐系统分配给第三方服务器2种用户号码 ，Web注册访问用户（可以用于注册回调
地址，可以发送短信等操作），Web访问用户（不可以注册回调地址，对应的注册访问用户注册后，可以发送短信等操作）。
补充说明：Web访问用户在哪个应用发送短信，就要在该应用下接受短信。
第三方服务器与宽乐Web Service服务器互相开放Web Service接口，互为服务器和客
户端，接口符合本文定义。注意无论第三方服务器在公网或者私网内，都需要向宽乐Web Service服务器提供Web Service服务接口并能够访问宽乐的Web Service服务。
1.2 接口总体说明
宽乐提供的短信相关的Web Service接口：
1） 注册接口：Register
URL: http://202.105.212.146:8080/jboss-net/services/Register
2） 发送短信：SendSMS
URL:http://202.105.212.146:8080/jboss-net/services/SendSMS
以上接口都需要客户端API鉴权，访问WebService时请添加用户名，密码(test/test)。 第三方必须提供WebService回调接口： 接口名：由第三方给出
方法：NotifyStatus、RecvSMS、EchoOfSendSMS
URL：由第三方给出
下表列出宽乐系统定义的Web Service（短信相关）请求和事件报告所使用的接口方法： 接口 注册接口 注册接口 收发短信 请求和事件 获取随机数请求 注册回调地址请求 回调地址更改报告 发送短信请求 发送短信结果报告 发送短信回执 接收短信请求 方法（函数） getRandom setCallBackAddr NotifyStatus sendSMS NotifyStatus EchoOfSendSMS RecvSMS 方向 3rd Server ? UC Portal 3rd Server ? UC Portal UC Portal ? 3rd Server 3rd Server ? UC Portal UC Portal ? 3rd Server UC Portal ? 3rd Server UC Portal ? 3rd Server 1.3 收发短信流程 1.3.1 注册
注意：第三方应用启动后，只需要调用一次该接口获得连接id即可，后续所有要用到connID的地方都可以用该值，不需要每次发送短信都注册。
(1) 第三方服务器调用Web Service服务器的getRandom获取校验用的随机数。 (2) 第三方服务器用随机数与登录密码加密后，向Web Service服务器发起注册回调地
址请求setCallBackAddr，该请求携带回调地址参数指明第三方服务器对UC开放的WebService接口的IP地址、URL和端口。UC对帐号密码鉴权通过后注册该帐号及对应的回调服务信息，生成一个连接id返回给第三方服务器，该连接id在第三方服务器后续的请求中携带。一个帐号只能创建一个连接，最新的注册将使以前注册的回调地址信息失效。
1.3.2 发送短信
(1) 第三方服务器重新调用Web Service服务器的getRandom获取校验用的随机数，并用
该随机数加密sendSMS接口调用的UC密码。
(2) 第三方服务器调用Web Service服务器的发送短信请求sendSMS接口。 (3) Web Service服务器把短信请求提交给AS。 (4) 如果鉴权成功，AS把短信提交到短信中心。 (5) AS通知Web Service服务器发送成功。
(6) Web Service服务器通过调用回调事件接口NotifyStatus向第三方服务器上报发送
短信状态。
(7) 被叫接收到短信，Web Service服务器通知AS短信回执。 (8) AS计费，落话单。
(9) AS通知Web Service服务器第三方收到回执
(10) Web Service服务器通过调用发送短信回执EchoOfSendSMS接口向第三方服务器
通知被叫接收短信状态。
短信发送流程如下：
第三方服务器WebService服务器AS短信中心1获取随机数(HTTP)返回随机数(HTTP 200 OK)2发送短信(HTTP)3将短信提交到AS(HTTP 200 OK)4将短信提交到短信中心5通知第三方发送成功6notifystatus (HTTP 200 OK)7短信回执8计费、话单9通知第三方收到回执10向第三方推送回执(HTTP 200 OK)
1.3.3 接收短信
注意：宽乐帐号要能接收到短信，需要Web注册访问账号已经注册过（提交了回调地址）。 (1) 宽乐接收短信时，Web Service服务器通过调用接收短信接口RecvSMS向第三方服
务器通知接收短信。
2 接口定义
以下可选项，可以填空字符串””。 2.1 注册接口 2.1.1 获取随机数
?
接口说明：
第三方服务器通过该接口获取对后续请求加密的随机数。每次调用其他函数，都需要先调用该函数获取新的随机数。
? 接口格式：
String getRandom();
? 输入参数说明： 参数 类型 必选/可选 说明 ? 返回参数说明： 参数 rand
类型 String 必选/可选 必选 失败返回-1 说明 成功返回大于0的随机数 2.1.2 注册/更改回调地址
?
接口说明：
该接口用于第三方服务器注册它的回调WebService接口的地址，获取连接id。 ? 接口格式：
String setCallBackAddr(String uc, String pw, String rand, String url);
? 输入参数说明：