宽乐通信WEB SERVICE接口说明书(短信).docVIP

宽乐通信 WebService接口说明书摘要：本文档主要描述宽乐通信对第三方服务器开放收发短信业务能力的WebService接口，对接口格式和相应的参数给出了详细的描述。总述宽乐系统（UC）通过WebService接口对外提供CTD(点击拨号)、CTC（点击会议）、收发短信等业务能力。宽乐系统分配给第三方服务器的2种用户号码 ，WebService注册用户（可以用于注册回调地址，可以发起呼叫等操作），WebService呼叫用户（不可以注册回调地址，可以发起呼叫等操作）。第三方服务器与宽乐Portal互相开放WebService接口，互为服务器和客户端，接口符合本文定义。注意无论第三方服务器在公网或者私网内，都需要向宽乐Portal提供WebService服务接口并能够访问Portal的WebService服务。宽乐提供的短信相关的WebService接口：注册接口：Register HYPERLINK URL:http://IP:port/jboss-net/services/Register URL:http://IP:port/jboss-net/services/Register发送短信：SendSMS HYPERLINK URL:http://IP:port/jboss-net/services/SendSMS URL:http://IP:port/jboss-net/services/SendSMS以上接口都需要客户端API鉴权，访问WebService时请添加用户名，密码(test/test)。第三方必须提供WebService回调接口：接口名：由第三方给出方法：NotifyStatus、RecvSMS、RecvSMSV2、EchoOfSendSMSURL：由第三方给出下表列出宽乐系统定义的WebService请求和事件报告所使用的接口方法：接口请求和事件方法（函数）方向注册接口获取随机数请求getRandom3rd Server ? UC Portal注册接口注册回调地址请求setCallBackAddr3rd Server ? UC Portal注册回调地址请求V2setCallBackAddrV23rd Server ? UC Portal回调地址更改报告NotifyStatusUC Portal ? 3rd Server收发短信发送短信请求sendSMS3rd Server ? UC Portal发送短信请求V2sendSMSV23rd Server ? UC Portal发送短信结果报告NotifyStatusUC Portal ? 3rd Server发送短信回执echoOfSendSMSUC Portal ? 3rd Server接收短信请求recvSMSUC Portal ? 3rd Server接收短信请求V2recvSMSV2UC Portal ? 3rd Server第三方服务器通过WebService接口调用UC短信能力的典型流程如下：第三方服务器调用UC portal的getRandom获取校验用的随机数。第三方服务器用随机数与登录密码加密后，向UC Portal发起注册回调地址请求setCallBackAddr，该请求携带回调地址参数指明第三方服务器对UC开放的WebService接口的IP地址、URL和端口。UC对帐号密码鉴权通过后注册该帐号及对应的回调服务信息，生成一个连接id返回给第三方服务器，该连接id在第三方服务器后续的请求中携带。一个帐号只能创建一个连接，必威体育精装版的注册将使以前注册的回调地址信息失效。第三方应用启动后，只需要调用一次该接口获得连接id即可，后续所有要用到connID的地方都可以用该值。第三方服务器重新调用UC portal的getRandom获取校验用的随机数，并用该随机数加密sendSMS接口调用的UC密码。第三方服务器调用UC Portal的发送短信请求sendSMS接口。如果鉴权成功，并成功把短信请求提交到短信中心，UC Portal通过调用回调事件接口NotifyStatus向第三方服务器上报发送短信状态。被叫接收到短信，UC Portal通过调用发送短信回执echoOfSendSMS接口向第三方服务器通知被叫接收短信状态。宽乐接收短信时，UC Portal通过调用接收短信接口recvSMS向第三方服务器通知接收短信。 短信发送流程如下：接口定义以下可选项，可以填空字符串””。注册接口获取随机数接口说明：第三方服务器通过该接口获取对后续请求加密的随机数。每次调用其他函数，都需要先调用该函数获取新的随机数。接口格式：String getRandom();输入参数说明：参数类型必选/可选说明返回参数说明：参数类型必选/可选说明randString必选成功