统一通信平台接口Word文档格式.docx

1、采用webservice和xmpp相结合的方式处理ucstarserver对外接口，并提供了相应的java代码示例。用webservice接口进行访问控制2 业务逻辑WebService接口http:/localhost:9090/services/UcstarWebservice?wsdl（请把localhost改成您的ucstart服务器所在的IP或者域名地址）2.2 Webserivce调用说明2.2.1 基本资源文件 资源文件：ucstarserver_webservice.jar包 JAVA工程：prj_webservice_jar 环境要求: JDK1.4以上注：webservic

2、e接口目前只是提供了JAVA的例子程序，如需要C+、PHP、C#等调用方式，请联系我公司配合完成。 进入管理后台打开webservice接口 将ucstarserver_webservice.jar包添加到工程中 将工程prj_webservice_jar中的测试代码添加到java工程中 修改测试程序TestWebserviceGetUser:修改其中的connect中的地址，改成真实的ucstar服务器地址。运行测试程序，如果能正确打印“测试成功:admin”，则说明webservice建立成功。测试程序：TestWebserviceGetUser.javapackage qflag.ucs

3、tar.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（/210.77.82.42:WS

4、DL）; /调用webservice接口获取用户信息 UcstarUser user = WebserviceManager.getInstance（）.getWebservice（）.getUser（admin /输出用户姓名 System.out.println（测试成功:+user.getUsername（）; catch （Exception e） e.printStackTrace（）; 2.3.1.1.1 查询该用户的详情资料getUserpublic UcstarUser getUser（java.lang.String userName） 参数： userName - 用户帐号

5、 返回： 返回用户对象2.3.1.1.2 查询用户状态getUserStatepublic UcstarUserState getUserState（java.lang.String userName） 返回用户状态对象2.3.1.1.3 添加用户资料addUserpublic int addUser（UcstarUser user） user（UcstarUser - 用户对象） 返回参数： 0 添加成功 注意：如UcstarUser中部门id没填，则默认部门id为0 1 添加失败 因:账号为空或用户名为空 2 添加失败 因:已有用户存在 3 添加失败 因:部门ID在部门表中不存在2.3.1

6、.1.4 修改用户资料updateUserpublic int updateUser（UcstarUser user） _user - 用户对象 20 修改成功 21 修改失败 因该用户不存在 22 修改失败 因部门ID不存在2.3.1.1.5 删除该用户deleteUserpublic int deleteUser（java.lang.String userName） 40 删除成功 41 删除失败 （因：没有该用户）2.3.1.1.6 根据用户账号修改密码updateUserPasswordStrictpublic int updateUserPasswordStrict（java.lan

7、g.String username, java.lang.String oldpassword, java.lang.String newpassword） username - 用户帐号 oldpassword - 用户原有密码 newpassword - 用户的新密码 int ,20修改成功2.3.1.1.7 根据用户账号查姓名getNamepublic java.lang.String getName（java.lang.String _userName） _userName - 用户帐号 返回用户姓名2.3.1.1.8 根据部门账号获取用户列表getUserListpublic Ucs

8、tarUser getUserList（java.lang.String deptid） deptid - 部门ID 用户列表数组2.3.1.1.9 获取所有在线用户数量getAllOnlineCountpublic int getAllOnlineCount（） 在线用户数量2.3.1.1.10 获取用户email列表getEmailspublic java.lang.String getEmails（java.lang.String userIds, java.lang.String deptarIds, java.lang.String bindIds） userIds - 用户ID（多

9、用户用逗号隔开） deptIds - 部门ID（多部门用逗号隔开） bindIds - 群组ID（多群组用逗号隔开） 返回Email列表（逗号隔开）2.3.1.1.11 验证用户名和密码authUserpublic int authUser（java.lang.String username, java.lang.String password） password - 用户密码 1:正确 0:错误2.3.1.1.12 验证session的正确性authSessionpublic int authSession（java.lang.String _sessionId） _sessionId -

10、单点登陆获取的sessionid 1：正确， 0：不正确2.3.1.2.1 查询部门的详细信息getDepartInfopublic UcstarDept getDepartInfo（java.lang.String deptid） departId - String 部门ID UcstarDept 返回部门对象2.3.1.2.2 添加部门addDeptpublic int addDept（UcstarDept deptInfo） deptInfo - 部门对象 0 增加成功 4 增加失败 因：部门已存在 5 增加失败 因：（因:父部门不存在） 6 增加失败 因：传入的对象UcstarDept

11、对象为空或里面数据为空2.3.1.2.3 更新部门信息updateDeptpublic int updateDept（UcstarDept deptInfo） 23 修改失败 因:所要修改的部门不存在2.3.1.2.4 删除部门deleteDeptpublic int deleteDept（java.lang.String deptid, java.lang.String completedelete） 部门id - 0:不删除子部门 - 1:删除子部门 42 删除失败 表中不存在要删除的部门Id 43 删除失败 参数completedelete 没有传值2.3.1.2.5 根据部门获取子部门

12、列表getDeptListpublic UcstarDept getDeptList（java.lang.String deptid） 返回下级部门列表数组2.3.1.2.6 根据部门名称查找部门searchDeptByNamepublic UcstarDept searchDeptByName（java.lang.String deptName） deptName - 部门名称 部门对象列表2.3.1.2.7 删除部门中的用户（关系）deleteDepartUserpublic void deleteDepartUser（java.lang.String _departuri, java.l

13、ang.String _useruris） _departuri 部门ID _useruris 用户帐号组成的数组2.3.1.2.8 给部门中添加用户（关系）addDepartUserpublic void addDepartUser（java.lang.String _departuri,2.3.1.3.1 查看群组getBindGroupInfopublic UcstarBindGroup getBindGroupInfo（java.lang.String bindgroupid） bindgroupid - 群组ID 返回群组对象2.3.1.3.2 增加群组addBindGrouppub

14、lic int addBindGroup（UcstarBindGroup bindGroup） bindGroup - 群组对象 群组已存在传入的对象UcstarBindGroup对象为空或里面数据为空2.3.1.3.3 删除群组deleteBindGrouppublic int deleteBindGroup（java.lang.String bindgroup_id） bindgroup_id - 群组ID 42 删除失败 表中不存在要删除的群组Id,或者bindgroupid为空2.3.1.3.4 修改群组updateBindGrouppublic int updateBindGroup

15、（UcstarBindGroup _bindgroup） _bindgroup - 群组对象 23 修改失败 因：所要修改的群组不存在 24 修改失败 因：所要修改的群组名不能为空2.3.1.3.5 向群组中添加用户addUserToBindGrouppublic int addUserToBindGroup（java.lang.String _bindgroup_id, java.lang.String _user_ids, boolean _administrator） _bindgroup_id - 群组ID _user_ids - 用户列表，用逗号隔开 _administrator -

16、 是否是管理员（true/false） 7 增加失败 该群组不存在 8 增加失败 所要添加的用户账号本身不存在2.3.1.3.6 获取群组下的用户getUsersByBindGouppublic UcstarUser getUsersByBindGoup（java.lang.String bindGroupId） bindGroupId - 群组ID 返回用户列表数组2.3.1.3.7 获取群组中的人员列表getBindGroupUserNamespublic java.lang.String getBindGroupUserNames（java.lang.String _bgId） _bgI

17、d 群组ID 群组下面的用户帐号数组2.3.1.3.8 删除群组中指定的用户deleteUsersFromBindGrouppublic int deleteUsersFromBindGroup（java.lang.String bindgroup_id, java.lang.String _user_ids） bindgroup_id - _user_ids - 可以为多用户,但必需用逗号隔开。如 1001,1002,1003 44 删除失败 因：所要删除的用户不存在 45 删除失败 因：所要删除用户的那个群组不存在2.3.1.3.9 删除该群组下的所有用户deleteAllUsersFro

18、mBindGrouppublic int deleteAllUsersFromBindGroup（java.lang.String bindgroup_id） 删除该群组下的所有用户2.3.1.3.10 修改群组中用户的管理状态updataUserfromBindGrouppublic int updataUserfromBindGroup（java.lang.String _bindgroup_id, java.lang.String _user_id, _user_id - 用户ID _administrator - 是否是管理员 所要修改用户的那个群组不存在2.3.1.3.11 根据父群

19、组ID获取子群组列表getBindGroupspublic UcstarBindGroup getBindGroups（java.lang.String _pbgId） _pbgId 父群组ID返回： 群组数组2.3.1.4.1 发送消息sendMsgpublic void sendMsg（java.lang.String username, java.lang.String deptid, java.lang.String content） username - 接收者帐号，多帐号用逗号隔开 deptid - 接收部门ID,多部门用逗号隔开 content - 发送内容2.3.1.4.2 发

20、送消息2sendMessagepublic int sendMessage（UcstarMessage _msg） _msg - 消息对象 返回成功或者失败:成功 其他:失败2.3.1.4.3 广播消息对所有的用户进行广播 statue = 0; 广播所有在线用户 statue = 1; 广播所有用户（包括离线用户）broadcastMessageAllpublic void broadcastMessageAll（java.lang.String message, int statue） message - 消息内容 type - 消息类型 发送给所有在线用户 发送给所有用户2.3.1.4.

21、4 指定广播发送广播给指定用户、部门、群组broadcastMessagepublic void broadcastMessage（java.lang.String message, java.lang.String userIds, java.lang.String deptIds, java.lang.String bindGroupIds, bindGroupIds - 群组ID（多群组用逗号隔开） statue - 状态：0: 发送给在线用户 1: 发送给在线和离线用户2.3.1.4.5 广播web内容客户端弹出类似QQ新闻的内容broadcastWebApppublic void b

22、roadcastWebApp（java.lang.String title, java.lang.String content, java.lang.String url, int type, int statue, java.lang.String creater） title - 弹出框标题 content - 内容 url - 内容对应的URL显示 type - 类型： statue - 状态2.3.1.4.6 发送消息给插件服务sendPluginPacketpublic void sendPluginPacket（java.lang.String service, java.lang

23、.String sender, service - 插件服务名称，例如短信的是（SMS） content - 发送协议的内容2.3.1.4.7 发送短信sendSmspublic java.lang.String sendSms（UcstarSMS smsParam） smsParam - 返回状态 0; /发送失败 1; /发送成功 2; /正在发送，请等待结果 3; /未知 4; /发送失败，你的余额已不多，请尽快冲值 5; /发送失败，你的余额已不足 6; /发送失败，信息中包含敏感字符 7; /发送失败，你无权发送短信 8; /发送失败，网络传输错误 9; /发送失败，信息内容长度超过

24、允许范围 10; /发送失败，你今天的短信数量已经用完 11; /发送失败，你的帐户中已经没有剩余短信 12; /发送失败，接收方号码有误 13; /短信网关未启动 14; /发送失几，短信数据数量已用完2.3.1.5 其他接口2.3.1.5.1 清空所有组织架构清空数据库和缓存中的组织架构信息（用户和部门）deleteAllOrgpublic void deleteAllOrg（）2.3.1.5.2 刷新组织架构缓冲，刷新缓存refreshOrgpublic void refreshOrg（）详细请参看JAVA的API说明：ucstarserver_webservice_apiwebserv

25、iceindex.html2.3.1.5.3 得到部门下用户状态根据部门ID得到部门下用户状态，flag=true：子部门用户状态也取出来 polarbear 2008-12-25getUserStateByDeptpublic UCUserStateExt getUserStateByDept（java.lang.String deptids, boolean flag） deptids 部门列表 flag 是否包含下级部门 用户状态列表2.3.1.5.4 根据用户名返回其中在线用户状getUserStateByUserIdspublic UCUserStateExt getUserStateByUserIds（java.lang.String usernames） usernames 用户帐号列表