宽乐通信WebService接口中间件接口说明书

宽乐WebService接口中间件接口说明书第1页,共30页宽乐通信WebService接口中间件使用说明书广东省电信有限公司研究院2007年4月宽乐WebService接口中间件接口说明书第2页,共30页目录1总述.........................................................................................................................31.1宽乐通信WebService接口中间件简介...................................................31.2在第三方服务器内内作用和应用模式......................................................41.3第三方服务器应用开发架构......................................................................52系统管理接口.........................................................................................................62.1业务参数管理服务......................................................................................62.2宽乐通信注册服务......................................................................................83用户接口...............................................................................................................103.1CTD接口...................................................................................................103.1.1发起CTD呼叫................................................................................113.1.2停止CTD呼叫................................................................................123.1.3查询CTD呼叫信息........................................................................133.2CTC接口...................................................................................................143.2.1发起CTC呼叫................................................................................153.2.2终止CTC的呼叫............................................................................163.2.3添加与会者......................................................................................173.2.4剔除与会者......................................................................................183.2.5查询会议列表..................................................................................183.2.6查询会议信息..................................................................................193.3SMS接口...................................................................................................213.3.1发送SMS.........................................................................................224第三方服务器应用对本中间件的回调服务.......................................................234.1接收后向呼叫处理事件............................................................................244.1.1设置回调地址回调事件..................................................................244.1.2发起CTD呼叫回调事件................................................................244.1.3呼叫释放回调事件..........................................................................254.1.4发起CTC会议回调事件................................................................254.1.5与会者进入会议回调事件..............................................................264.1.6与会者退出会议回调事件..............................................................264.1.7会议释放回调事件..........................................................................274.1.8发送短信回调事件..........................................................................274.2SMS回执...................................................................................................284.3接收SMS...................................................................................................295通用失败码...........................................................................................................30宽乐WebService接口中间件接口说明书第3页,共30页摘要：本文档主要描述宽乐通信WebService接口中间件在第三方服务器部署时为第三方服务器应用提供的接口说明。对第三方服务器应用调用本中间件接口的开发架构，以及接口方法参数定义作了详细说明。1总述1.1宽乐通信WebService接口中间件简介宽乐通信WebService接口中间件封装了宽乐通信平台WebService接口通信的能力。该中间件部署于第三方服务器上，使得第三方服务器上的应用可以通过对本中间件的接口调用而达到接入和使用宽乐通信业务多媒体通信能力的目的。本中间件使用java开发，适于部署于支持WebService的java应用服务器上。目前，本中间件向第三方服务器应用提供的宽乐通信能力有：－点击拨号－发起呼叫－停止呼叫－查询呼叫信息－点击会议－发起会议－增加与会者－剔除与会者－停止会议－查询会议列表、会议信息－短信收发－发送或群发短信－接收短信回执－接收后向短信宽乐WebService接口中间件接口说明书第4页,共30页1.2在第三方服务器内内作用和应用模式本中间件作为宽乐通信第三方服务器应用的一部分，实现与宽乐通信平台的双向WebService接口交互（即双方都作为对方WebService的客户端和服务器端）。目前，宽乐通信通过WebService接口提供出来的业务能力有点击拨号、点击会议和短信收发等宽乐通信业务功能，本中间件已经封装了这些能力的WebService接口调用。本中间件提供给第三方服务器部署，充当第三方服务器应用接入和使用宽乐通信业务能力的解决方案。在第三方服务器中，本中间件有两种应用模式，一种是与第三方服务器应用共用一个支持WebService的java平台；另一种是在第三方服务器中，与第三方服务器应用使用不同的平台。第一种模式中，因为与第三方服务器应用共用一个java平台，所以本中间件将成为第三方服务器应用的一部分。第三方服务器应用可以以本地接口的方式访问本中间件，如下图所示：图1模式一：与第三方服务器应用共用java平台部署宽乐WebService接口中间件接口说明书第5页,共30页第二种模式是在第三方服务器中，本中间件与第三方服务器应用分别使用独立的服务器平台，第三方服务器应用通过webservice接口访问本中间件。如下图所示：图2模式二：与第三方服务器不同平台（容器）部署总之，本中间件对第三方服务器应用提供多种方式的接口。部署在第三方服务器上之后，第三方服务器原有的java应用可以直接调用本中间件的接口，也可以通过webservice调用本中间件接口。本文档提供以第二种模式，也就是与第三方服务器使用不同平台部署的方式，向其他应用提供webservice接口的说明。1.3第三方服务器应用开发架构第三方服务器的应用在使用本中间件时需要遵守一些规则。本中间件向第三方服务器应用提供了管理接口服务和用户接口服务两部分。宽乐WebService接口中间件接口说明书第6页,共30页其中管理员接口服务是为第三方服务器中管理员应用提供的接口，完成对本中间件参数以及与宽乐通信业务通信的管理。用户接口是第三方服务器中完成用户应用的接口。主要是提供给第三方服务器完成CTC、CTD和SMS等宽乐通信功能的接口。第三方服务器应用应该首先调用本中间件的管理员服务接口以完成设置后，才能调用用户部分接口。第三方服务器调用本中间件接口的典型流程如下：(1)第三方服务器应用调用本中间件的管理服务接口设置业务管理参数。(2)第三方服务器应用调用本中间件注册服务的registerToService方法向宽乐通信业务注册本服务器的管理员宽乐通信账号和本地webservice地址。(3)第三方服务器可以进行用户服务接口的调用。例如处理用户的CTD请求时，先调用本中间件dialCallClient发起呼叫，然后调用releaseCallClient方法结束呼叫。2系统管理接口系统管理接口主要用于实现管理宽