好视通视频会议私有云产品接入接口规范V1.0.doc

深圳银彭云计算股份有限公司好视通视频会议私有云产品接入接口规范深圳银澎云计算股份有限公司2015年6月1日版本修订记录版本号修订日期修订人修订记录1.02015-06-02高文杰新增：汇总以下文档，合并为该文档好视通企业版接口说明好视通IOS接口说明好视通Android接口说明目 录一、文档说明51.1.接口应用说明51.2.本文档适用读者5二、接口范围6三、PC客户端调用接口63.1.接口说明：63.2.命令行登录接口73.3.页面登录接口8四、IOS客户端调用接口114.1.调用接口说明114.2.用户名和密码方式登录124.3.仅仅启动APP12五、Android客户端调用接口125.1.调用接口说明135.2.用户名和密码方式登录135.3.仅仅启动APP14六、会控及数据交互接口146.1.接口协议146.2.WebService接口功能列表156.2.1.新增用户信息156.2.2.批量注册用户156.2.3.修改用户信息166.2.4.删除用户信息176.2.5.获得用户信息176.2.6.新增会议186.2.7.通过会议室给用户授权186.2.8.通过用户名给会议授权196.2.9.删除会议室196.2.10.修改会议室信息196.2.11.获取会议室信息206.2.12.获取用户有权限的会议室列表206.2.13.获取会议室授权的用户列表216.2.14.获取会议室登录地址216.2.15.错误信息代码216.2.16.调用方式参考21一、 文档说明1.1. 接口应用说明随着移动互联网、智能终端和“互联网+”的飞速发展，云会议产品已经深入到金融、交通、运输、教育等不同行业，而且在人们的日程生活、工作中起着日益重要的作用。同时，各类消费者的不同需求也要求厂家能够提供更加细致的定制化功能。比如和企业网站的交互、企业办公软件（OA）的交互。针对市场需求，好视通推出了视频会议企业版接口，涵盖了客户端的命令行调用、Web页面调用、IOS客户端调用、Android客户调用等不同调用方式；通过WebService接口，为客户提供了更加丰富的二次开发接口，客户可通过WebService接口，对登陆会议的账号、会议室、权限等进行更加细致的功能开发。1.2. 本文档适用读者本文档在于定义好视通云会议产品与第三方系统交互的接口，包括但不限于产品之间的互相调用以及业务模块之间通讯的接口协议，用于好视通产品的OEM或者ODM项目，以及第三方厂家的二次开发工作。本文档的适用读者包括：1) 好视通云会议产品相关销售、测试、研发人员。2) 第三方厂家相关销售、测试、研发人员二、 接口范围本文档涵盖的产品包括：好视通私有云会议管理平台、好视通视频会议客户端、好视通IOS客户端、好视通Android客户端。三、 PC客户端调用接口3.1. 接口说明：好视通运营平台提供2种客户端登录接口，供第三方产品调用。分别为：1、 命令行登录接口：命令行登录接口是通过在好视通客户端进程名后面添加命令行参数的方法，启动好视通客户端，登录会议。2、 页面登录接口通过web页面方式，可直接启动好视通客户端。如果是嵌入B/S系统，建议采用第2种页面登录接口。如是果嵌入C/S系统，建议采用第1种命令行登录接口。3.2. 命令行登录接口好视通客户端进程为客户端安装目录的FastMeeting.exe文件，客户端安装目录默认为C:Program FilesFastonzFMClientFMDesktopFastMeeting.exe，可以通过查询注册表路径HKEY_CURRENT_USERSoftwareFastonzFMDesktop下的FilePath，获得客户端进程的完整路径名。客户端的命令行参数定义如下：-rid 会议室ID-rpwd会议室密码-uname（必填）用户名-upwd用户密码-utype用户类型，0为游客 1为注册用户，默认为1-link（必填） 服务器登录地址，例如 TCP:localhost:1089-node节点ID（一般不需要填写）-run 客户端登录后的自动执行的操作，定义如下:RA申请发言RD申请主讲RV 广播本地视频RR 开始会议录制W1切换到标准布局W2 切换到培训布局W3 切换到视频布局WF切换到全屏模式WV1 切换到1分屏模式WV2 切换到2分屏模式WV3 切换到画中画分屏模式WV4 切换到4分屏模式WV6 切换到6分屏模式WV9 切换到9分屏模式WV12 切换到12分屏模式WV16 切换到16分屏模式WV25 切换到25分屏模式可以同时使用多个操作，中间用分号分隔当utype为1时，-upwd为必填当utype为0时，-rid为必填例如：FastMeeting -rid 10104 uname t08 upwd 8888 link TCP:localhost:1089FastMeeting -rid 10104 rpwd 1111 uname hello utype 0 link TCP:localhost:1089如果某项参数为空，相应的前缀也不能出现在命令行中，例如：FastMeeting -rid uname t08 upwd 8888 link TCP:localhost:1089就是错误的，因为-rid参数为空，就不应该在命令行中添加-rid3.3. 页面登录接口3.3.1使用好视通登录页面好视通运营平台提供了使用URL地址的方式直接进入会议，其调用接口为：http:/ localhost:8080/fm/userMgr/entermeeting.jsp可输入参数如下：userName：用户名userPwd： 用户密码userType: 用户登陆类型，0为匿名登陆，1为凭用户名密码登陆roomID： 会议室ID号roomPwd： 会议室登陆密码（与后台设置的会议室登陆校验模型相关）出现以下两种情形之一时，登陆页面将会提示用户输入用户名和密码：1、未带参数userName2、userType为1但未带参数userPwd如果userType为0时，不会显示密码输入框。示例参考：http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104&userName=t08&userPwd=8888http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104&userName=hello&userType=0&roomPwd=1111http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=101043.3.2自定义登录页面客户可以在自己的web页面中直接调用启动助手。示例代码如下：启动助手登陆协议：Launcher.FSM:/参数：客户端下载地址FastonzFMDesktop-link 服务器地址 -uname “用户名” -utype 用户类型 -rid 会议室id -upwd 用户密码 -rpwd 会议室密码 -node 1参数定义如下： -rid 会议室ID-rpwd会议室密码-uname（必填）用户名-upwd用户密码-utype用户类型，0为游客 1为注册用户，默认为1-link（必填） 服务器登录地址，例如 TCP:localhost:1089-node节点ID（默认1）1、 自定义协议组装：组装参数字符串，调用base64.js 中的 encode64方法编码，编码后的字符串，放到协议头之后，组装成 url 连接2、 安装好视通启动助手后，可直接把url连接，使用js(window.location.href = url;)打开，到这里就能把客户端调起来，并且自动进行参数赋值，可直接登陆到会议中。3、 Base64.js/ Base64.jsvar ua = navigator.userAgent.toLowerCase();if (ua.indexOf( chrome/) = 0 | ua.indexOf( firefox/) = 0 | ua.indexOf( gecko/) = 0) var StringMaker = function () this.str = ;this.length = 0;this.append = function (s) this.str += s;this.length += s.length;this.prepend = function (s) this.str = s + this.str;this.length += s.length;this.toString = function () return this.str; else var StringMaker = function () this.parts = ;this.length = 0;this.append = function (s) this.parts.push(s);this.length += s.length;this.prepend = function (s) this.parts.unshift(s);this.length += s.length;this.toString = function () return this.parts.join();var keyStr = ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=;function encode64(input) var output = new StringMaker();var chr1, chr2, chr3;var enc1, enc2, enc3, enc4;var i = 0;while (i 2;enc2 = (chr1 & 3) 4);enc3 = (chr2 & 15) 6);enc4 = chr3 & 63;if (isNaN(chr2) enc3 = enc4 = 64; else if (isNaN(chr3) enc4 = 64;output.append(keyStr.charAt(enc1) + keyStr.charAt(enc2) + keyStr.charAt(enc3) + keyStr.charAt(enc4); return output.toString();例如：第一步，参数串组装：http:/localhost:8080/download/FMDesktopV.exeFastonzFMDesktop-link TCP:localhost:1089 -uname “test” -utype 0 -rid 10001 -upwd 1111 -rpwd 1111 -node 1第二步，js调用例子Js调用：var url = Launcher.FSM:/ + encode64(http:/localhost:8080/download/FMDesktopV.exeFastonzFMDesktop-link TCP:localhost:1089 -uname “test” -utype 0 -rid 10001 -upwd 1111 -rpwd 1111 -node 1);setTimeout(function()window.location.href = url;, 1);四、 IOS客户端调用接口在IOS操作系统中，客户程序可以通过以下方式启动好视通IOS客户端。4.1. 调用接口说明参数说明：userName;用户名userPwd;用户密码userType;用户登陆类型，2为匿名登陆，1为凭用户名密码登陆roomID;会议室ID号roomPwd;会议室登陆密码（与后台设置的会议室登陆校验模型相关svrAddress;服务器地址nickName;昵称，userType=2匿名登录时才需要设置svrPort;服务器端口auto:1自动登录0手动登录4.2. 用户名和密码方式登录例如：用户名：hst 密码:111, 自动登录UIApplication sharedApplication openURL:NSURL URLWithString:”FSMeetingClient:/userType(1)userName(hst)userPwd(111)auto(1)”;如果需要设置服务器地址或端口UIApplication sharedApplication openURL:NSURL URLWithString:”FSMeetingClient:/userType(1)userName(hst)userPwd(111)auto(1)svrAddress(7)svrPort(1089)”;4.3. 仅仅启动APPUIApplication sharedApplication openURL:NSURL URLWithString:”FSMeetingClient:/”;五、 Android客户端调用接口5.1. 调用接口说明参数说明：userName：用户名userPwd：用户密码svrAddress：服务器地址svrPort：服务器端口5.2. 用户名和密码方式登录例如：用户名：hst 密码:111 ComponentName apk2Component1 = new ComponentName(com.fastonz.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTierActivity);Intent mIntent = new Intent();Bundle mBundle = new Bundle();mBundle.putString(“userName”,hst);mBundle.putString(“userPwd”,111);mIntent.putExtras(mbundle);mIntent.setComponent(apk2Component1);startActivity(mIntent);如果需要设置服务器地址或端口:ComponentName apk2Component1 = new ComponentName(com.fastonz.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTierActivity);Intent mIntent = new Intent();Bundle mBundle = new Bundle();mBundle.putString(“userName”,hst);mBundle.putString(“userPwd”,111);mBundle.putString(“svrAddress”, 7);mBundle.putString(“svrPort”, 1089);mIntent.putExtras(mbundle);mIntent.setComponent(apk2Component1);startActivity(mIntent);5.3. 仅仅启动APPComponentName apk2Component = new ComponentName(com.fastonz.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTierActivity);Intent intent = new Intent();intent.setComponent(apk2Component);startActivity(intent);六、 会控及数据交互接口6.1. 接口协议接口调用地址：http:/localhost:8080/fmws/services/WsService密钥：keyCode=fswebservice2011密钥用于对WebService接口的访问认证，默认为fswebservice2011，访问时需要对密钥进行MD5加密。接口中出现的keyCode都是fswebservice2011加密后字符串：3025495AEE146DA3864AB81BAAF79A3E 6.2. WebService接口功能列表6.2.1. 新增用户信息public String regUser(String username,String passpwd,String Nickname,String keyCode)说明：这里的密码（passpwd）是原密码，没有经过md5加密的。参数参数名中文名字符类型长度是否为空username用户名String64Npasspwd用户密码String16NNickname昵称String32NkeyCode密钥String32N 返回值： 字符串 参考返回码public String regUserMD5ed(String username,String passpwd,String Nickname,String keyCode)说明：这里的密码（passpwd），是原密码经过md5加密后的字符串参数，加密后的passpwd密码长度必须为32位参数名中文名字符类型长度是否为空username用户名String64Npasspwd用户密码String32NNickname昵称String32NkeyCode密钥String32N 返回值： 字符串 参考返回码6.2.2. 批量注册用户public String batchRegUser(String preName,int num,String passpwd,String keyCode)说明：这里的密码（passpwd），是原密码（没有经过md5加密的）参数参数名中文名字符类型长度是否为空preName前缀名String5Npasspwd用户密码String16NkeyCode密钥String32N返回值： 字符串 参考返回码6.2.3. 修改用户信息public String editUserinfo(int userid,String username,String passpwd,String nickname,String mobile,String email,String keyCode)说明：这里的密码（passpwd），是原密码（没有经过md5加密的）参数参数名中文名字符类型长度是否为空userid用户IDint默认Nusername用户名String64Npasspwd用户密码String16YNickname昵称String32Ymobile手机号码String15Nemail电子邮箱String100NkeyCode密钥String32N返回值： 字符串 参考返回码public String editUserinfoMD5ed(int userid,String username,String passpwd,String nickname,String mobile,String email,String keyCode)throws Exception;参数说明：这里的密码（passpwd），是原密码经过md5加密后的字符串参数，加密后的passpwd密码长度32位参数名中文名字符类型长度是否为空userid用户IDint默认Nusername用户名String64Npasspwd用户密码String32YNickname昵称String32Ymobile手机号码String15Nemail电子邮箱String100NkeyCode密钥String32N返回值： 字符串 参考返回码6.2.4. 删除用户信息public String delUser(int userid,String username,String keyCode)参数参数名中文名字符类型长度是否为空userid用户IDint默认N or Yusername用户名String64N or YkeyCode密钥String32Nuserid不能为空，如果不使用userid，可以指定为0返回值： 字符串 参考返回码6.2.5. 获得用户信息public String getUserinfoXml(int userid,String searchName,String keyCode)参数：参数名中文名字符类型长度是否为空userid用户IDint默认NsearchName搜索关键字String64YkeyCode密钥String32Nuserid不能为空，如果不使用userid，可以指定为0返回值 如：user-jdom.xml里内容6.2.6. 新增会议public String addRoominfo(String roomName,String roomType,String password,String verifyMode,int maxUserCount,String hopeStartTime,String hopeEndTime,String enableChairPwd,String chairPassword,String keyCode)说明：这里的密码（passpwd），是原密码（没有经过md5加密的）参数参数名中文名字符类型长度格式 是否为空roomName会议室名String64NroomType会议类型String11:固定会议室（无固定期限，永久有效）；2:预约会议室（有开始和结束时间）；3:临时会议室（会议室创建24小时之后，如果会议室内没有人，该会议室会自动删除）Npassword密码String16YverifyMode登录校验模型String11、用户密码验证；2、会议室密码验证；3、匿名登录 NmaxUserCount允许最大用户数int默认NhopeStartTime预定开始时间String20yyyy-mm-dd HH:mm:ss YhopeEndTime预定结束时间String20yyyy-mm-dd HH:mm:ss YenableChairPwd是否允许主席密码String1YchairPassword主席密码String16YkeyCode密钥String32采用MD5加密N返回值： 新增会议室ID。如果返回值10000，表示发生错误，返回错误码6.2.7. 通过会议室给用户授权public String doUserRightbyUserName(String arrUserNameandRight,int roomId,String keyCode)参数参数名中文名字符类型长度是否为空arrUserNameandRight需要改变的内容String2147483647NroomID会议IDint默认NkeyCode密钥String32N 返回值： 字符串 参考返回码arrUserNameandRight格式说明：用户名(userName) 权限值(UserRight)# 用户名(userName) 权限值(UserRight)权限值定义：1旁听 2 出席 3 主持权限值为空或为0时，表示取消该用户会议室权限6.2.8. 通过用户名给会议授权public String doRoomRightByUserName (String arrRoomIdandRight,String userName,String keyCode)参数参数名中文名字符类型长度是否为空arrRoomIdandRight需要改变的内容String2147483647NuserName用户名String默认NkeyCode密钥String32N返回值： 字符串 参考返回码arrRoomIdandRight 格式说明：会议ID(roomId) 权限值(UserRight)# 会议ID(roomId) 权限值(UserRight)6.2.9. 删除会议室public String delRoom(int roomID,String keyCode)参数参数名中文名字符类型长度是否为空roomID会议IDint默认NkeyCode密钥String32N返回值： 字符串 参考返回码6.2.10. 修改会议室信息public String editRoominfo(int roomid,String roomName,String roomType,String password,String verifyMode,int maxUserCount,String hopeStartTime,String hopeEndTime,String enableChairPwd,String chairPassword,String keyCode)说明：这里的密码（passpwd），是原密码（没有经过md5加密的）参数参数名中文名字符类型长度是否为空roomid前缀名String5N or YroomName用户密码String16N or YroomType会议类型String11:固定会议室（无固定期限，永久有效）；2:预约会议室（有开始和结束时间）Npassword密码String16YverifyMode登录校验模型String11、用户密码验证；2、会议室密码验证；3、匿名登录NmaxUserCount允许最大用户数int默认NhopeStartTime预定开始时间String20yyyy-mm