宽乐通信WebService接口说明书V1.1-短信 (2).docVIP

宽乐通信Web Service接口说明书V1.1（短信部分） 中国电信股份有限公司广州研究院 宽乐通信 Web Service接口46:8080/jboss-net/services/Register 发送短信：SendSMS URL:46:8080/jboss-net/services/SendSMS 以上接口都需要客户端API鉴权，访问WebService时请添加用户名，密码(test/test)。 第三方必须提供WebService回调接口： 接口名：由第三方给出 方法：NotifyStatus、RecvSMS、EchoOfSendSMS URL：由第三方给出 下表列出宽乐系统定义的Web Service（短信相关）请求和事件报告所使用的接口方法： 接口 请求和事件 方法（函数） 方向 注册接口 获取随机数请求 getRandom 3rd Server ? UC Portal 注册接口 注册回调地址请求 setCallBackAddr 3rd Server ? UC Portal 回调地址更改报告 NotifyStatus UC Portal ? 3rd Server 收发短信 发送短信请求 sendSMS 3rd Server ? UC Portal 发送短信结果报告 NotifyStatus UC Portal ? 3rd Server 发送短信回执 EchoOfSendSMS UC Portal ? 3rd Server 接收短信请求 RecvSMS UC 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注册访问账号已经注册过（提交了回调地址）。 宽乐接收短信时，Web Service服务器通过调用接收短信接口RecvSMS向第三方服务器通知接收短信。 接口定义 以下可选项，可以填空字符串””。 注册接口 获取随机数 接口说明： 第三方服务器通过该接口获取对后续请求加密的随机数。每次调用其他函数，都需要先调用该函数获取新的随机数。 接口格式： String getRandom(); 输入参数说明： 参数 类型 必选 返回参数说明： 参数 类型 必选必选 接口格式： String setCallBackAddr(String uc, String pw, String rand, String url); 输入参数说明： 参数 类型 必选 参数 类型 必选必选 String sendSMS(String uc, String pw, String rand, String callee[], String isreturn, String cont, int msgid, String connID); 输入参数说明： 参数 类型 必选uc String 必选 的号码pw String 必选 必选 String 必选 String 必选 该短信是否需要回执（0：不需要回执；1：需要回执。） cont String 可选 短信内容