统一通信平台接口.doc

UcSTARSERVER接口设计 2007-12-6(擎旗技术) 2009-3-24 修正 饶维立 目录 UcSTARSERVER接口设计 1 1 说明： 1 2 业务逻辑WebService接口 2 2.1 Webservice接口地址： 2 2.2 Webserivce调用说明 2 2.2.1 基本资源文件 2 2.2.2 使用之前注意事项： 2 2.3 Webserivce API说明： 3 2.3.1 JAVAAPI接口： 3 用户接口： 3 部门接口： 7 群组接口： 9 消息接口： 13 其他接口 16 2.3.2 JAVAAPI BEAN对象： 17 群组对象： 17 部门对象 17 消息对象 17 短信对象 19 用户对象 19 状态对象 20 状态扩展对象 20 3 短信公共接口 20 3.1 短信公共接口采用xmpp的注册方式： 21 3.1.1 流程： 21 3.1.2 接口说明： 21 说明： 采用webservice和xmpp相结合的方式处理ucstarserver对外接口，并提供了相应的java代码示例。 用webservice接口进行访问控制 业务逻辑WebService接口 Webservice接口地址： http://localhost:9090/services/UcstarWebservice?wsdl (请把localhost改成您的ucstart服务器所在的IP或者域名地址) Webserivce调用说明 基本资源文件 资源文件：ucstarserver_webservice.jar包 JAVA工程：prj_webservice_jar 环境要求: JDK1.4以上 注：webservice接口目前只是提供了JAVA的例子程序，如需要C++、PHP、C#等调用方式，请联系我公司配合完成。 使用之前注意事项： 进入管理后台打开webservice接口 将ucstarserver_webservice.jar包添加到工程中 将工程prj_webservice_jar中的测试代码添加到java工程中 修改测试程序TestWebserviceGetUser: 修改其中的connect中的地址，改成真实的ucstar服务器地址。 运行测试程序，如果能正确打印“测试成功:admin”，则说明webservice建立成功。 测试程序：TestWebserviceGetUser.java package qflag.ucstar.test; import qflag.ucstar.WebInterface.WebserviceManager; import qflag.ucstar.webservice.bean.UcstarUser; /** * 获取用户信息 * @author polarbear 2009-3-24 */ public class TestWebserviceGetUser { public static void main(String[] args) { try { //连接webservice服务地址 WebserviceManager.getInstance().connect(2:9090/services/UcstarWebservice?WSDL); //调用webservice接口获取用户信息 UcstarUser user = WebserviceManager.getInstance().getWebservice().getUser(admin); //输出用户姓名 System.out.println(测试成功:+user.getUsername()); } catch (Exception e) { e.printStackTrace(); } } } Webserivce API说明： JAVAAPI接口： 用户接口： 查询该用户的详情资料 getUser public UcstarUser getUser(java.lang.String userName) 参数： userName - 用户帐号 返回： 返回用户对象 查询用户状态 getUserState public UcstarUserState getUserState(java.lang.String userName) 参数： userName - 用户帐号 返回： 返回用户状态对象 添加用户资料 addUser publ