好视通视频会议私有云产品接入接口规范V

1、好视通视频会议私有云产品接入接口规范深圳银澎云计算股份有限公司2015年6月1日Word资料版本修订记录版本号修订日期修订人修订记录1.02015-06-02局文杰新增：汇总以卜文档，合并为该文档好视通企业版接口说明好视通IOS接口说明好视通 Android接口说明Word资料 TOC o 1-5 h z 文档说明5 HYPERLINK l bookmark9 o Current Document 接口应用说明 5 HYPERLINK l bookmark11 o Current Document 本文档适用读者5接口范围6 HYPERLINK l bookmark13 o Current D

2、ocument PC客户端调用接口 6 HYPERLINK l bookmark15 o Current Document 接口说明：6 HYPERLINK l bookmark17 o Current Document 命令行登录接口 7页面登录接口 9IOS客户端调用接口 1.3调用接口说明 13用户名和密码方式登录 1.3.仅仅启动APP.13Android客户端调用接口 .1.4调用接口说明 14用户名和密码方式登录 1.4仅仅启动APP.15会控及数据交互接口 15接口协议.15WebService 接口功能列表.16新增用户信息1.6批量注册用户1.7.修改用户信息1.7.删除用户

3、信息1.9获得用户信息1.9新增会议20通过会议室给用户授权 21.通过用户名给会议授权 21.删除会议室22Word资料修改会议室信息22获取会议室信息 23获取用户有权限白向会议室列表 24.获取会议室授权的用户列表 24获取会议室登录地址 25错误信息代码 25调用方式参考 26Word资料文档说明接口应用说明随着移动互联网、智能终端和“互联网+”的飞速发展，云会议产品已经深入 到金融、交通、运输、教育等不同行业，而且在人们的日程生活、工作中起着日 益重要的作用。同时，各类消费者的不同需求也要求厂家能够提供更加细致的定 制化功能。比如和企业网站的交互、企业办公软件（OA）的交互。针对市场

4、需求，好视通推出了视频会议企业版接口，涵盖了客户端的命令行 调用、Web页面调用、IOS客户端调用、Android客户调用等不同调用方式；通过 WebService接口，为客户提供了更加丰富的二次开发接口，客户可通过 WebService接口，对登陆会议的账号、会议室、权限等进行更加细致的功能开发。本文档适用读者本文档在于定义好视通云会议产品与第三方系统交互的接口，包括但不限于产品之间的互相调用以及业务模块之间通讯的接口协议，用于好视通产品的 OEM或者ODM项目，以及第三方厂家的二次开发工作。本文档的适用读者包括：1）好视通云会议产品相关销售、测试、研发人员。2）第三方厂家相关销售、测试、研

5、发人员Word资料接口范围好视通会议服务器ffebSorvicc凄供会捽及教相交忏接口好视通会议客户端pc客户端（URL出动接口）（命令行出动接口）I0S客户耕（第三方A叩信动接口）AndiMd客户端（第方启动接LJ）本文档涵盖的产品包括：好视通私有云会议管理平台、好视通视频会议客户端、好视通IO哈户端、好视通Android客户端。三、PC客户端调用接口接口说明：好视通运营平台提供2种客户端登录接口，供第三方产品调用。分别为：1、命令行登录接口 ：命令行登录接口是通过在好视通客户端进程名后面添加命令行参数的方法，启动好视通客户端，登录会议。2、页面登录接口通过web页面方式，可直接启动好视通客

6、户端。Word资料如果是嵌入B/S系统，建议采用第2种页面登录接口。如是果嵌入 C/S 系统，建议采用第1种命令行登录接口。命令行登录接口好视通客户端进程为客户端安装目录的FastMeeting.exe文件，客户端安装目录默认为 C:Program FilesFastonzFMClientFMDesktopFastMeeting.exe ,可 以通过查询注册表路径 HKEY_CURRENT_USERSoftwareFastonzFMDesktopT 的FilePath,获得客户端进程的完整路径名。客户端的命令行参数定义如下：rid会议室IDrpwd会议室密码uname （必填）用户名upwd用

7、户密码utype用户类型，0为游客1为注册用户，默认为1link （必填） 服务器登录地址，例如 TCP:localhost:1089node节点ID （一般不需要填写）run客户端登录后的自动执行的操作，定义如下：RA申请发言RD申请主讲RV广播本地视频Word资料RR开始会议录制W1切换到标准布局W2切换到培训布局W3切换到视频布局WF切换到全屏模式WV1切换到1分屏模式WV2切换到2分屏模式WV3切换到画中画分屏模式WV4切换到4分屏模式WV6切换到6分屏模式WV9切换到9分屏模式WV12切换到12分屏模式WV16切换到16分屏模式WV25切换到25分屏模式可以同时使用多个操作，中间用分

8、号分隔当utype为1时，-upwd为必填当utype为0时，-rid为必填例如：FastMeeting -rid 10104- uname t08- upwd 8888- linkTCP:localhost:1089Word资料FastMeeting -rid 10104 - rpwd 1111 - uname hello - utype 0 - linkTCP:localhost:1089如果某项参数为空，相应的前缀也不能出现在命令行中，例如：FastMeeting -rid - uname t08 - upwd 8888 - link TCP:localhost:1089就是错误的，因为

9、-rid参数为空，就不应该在命令行中添加-rid页面登录接口使用好视通登录页面好视通运营平台提供了使用URL地址的方式直接进入会议，其调用接口为:http:/ localhost:8080/fm/userMgr/entermeeting.jsp可输入参数如下：userName :用户名userPwd :用户密码userType:用户登陆类型，0为匿名登陆，1为凭用户名密码登陆roomID :会议室ID号roomPwd :会议室登陆密码（与后台设置的会议室登陆校验模型相关）出现以下两种情形之一时，登陆页面将会提示用户输入用户名和密码:1、未带参数 userName2、userType为1但未带参

10、数 userPwd如果userType为0时，不会显示密码输入框。Word资料示例参考:http:localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104&userName=t08&userPwd=8888 HYPERLINK http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104&userNa http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104&userName=hello&userType=0&ro

11、omPwd=1111 HYPERLINK http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104 http:/localhost:8080/fm/userMgr/entermeeting.jsp?roomID=10104自定义登录页面客户可以在自己的 web页面中直接调用启动助手。示例代码如下:启动助手登陆协议：Launcher.FSM:参数：客户端下载地址FastonzFMDesktop-link服务器地址 -uname 用户名-utype 用户 类型-rid 会议室id -upwd 用户密码-rpwd 会议室密码 -nod

12、e 1参数定义如下:-rid会议室ID-rpwd会议室密码-uname （必填）用户名-upwd用户密码-utype用户类型，0为游客1为注册用户，默认为-link （必填）服务器登录地址，例如TCP:localhost:1089-node节点ID (默认1)11、自定义协议组装：组装参数字符串，调用 base64.js 中的encode64方法编码，编码后 的字符串，放到协议头之后，组装成 url连接2、安装好视通启动助手后，可直接把 url连接，使用js(window.location.href = url;)打开，到 这里就能把客户端调起来，并且自动进行参数赋值，可直接登陆到会议中。3、

13、Base64.js/ Base64.jsvar ua = navigator.userAgent.toLowerCase();Word资料 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 = fun

14、ction (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);

15、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 &

16、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();例如：第一步，参数串组装： HYPERLINK http:/localhost:8080/download/FMDesktopV.

17、exe%7d%7b http:/localhost:8080/download/FMDesktopV.exeFastonz FMDesktop-linkTCP:localhost:1089 -unametest -utype 0 -rid 10001 -upwd 1111 -rpwd 1111 -node 1第二步，js调用例子Js调用:var url = Launcher.FSM:/ +encode64( HYPERLINK http:/localhost:8080/download/FMDesktopV.exe%7d%7bFastonz%7d%7bFMDesktop%7d%7b-link

18、http:/localhost:8080/download/FMDesktopV.exeFastonzFMDesktop-link TCP:localhost:1089 -uname fest -utype 0 -rid 10001 -upwd 1111 -rpwd 1111 -node 1); setTimeout( function ()window.location.href = url;. 1);Word资料四、IOS客户端调用接口在IOS操作系统中，客户程序可以通过以下方式启动好视通 IOS客户端参数说明：userName;userPwd;userType;roomID;roomPw

19、d;svrAddress;nickName;svrPort;auto:调用接口说明用户名用户密码用户登陆类型，2为匿名登陆，1为凭用户名密码登陆会议室ID号会议室登陆密码（与后台设置的会议室登陆校验模型相关服务器地址昵称，userType=2匿名登录时才需要设置服务器端口1自动登录0手动登录用户名和密码方式登录例如：用户名：hst密码：111,自动登录UIApplication sharedApplication openURL:NSURL URLWithString: ”FSMeetingClient:userType(1)userName(hst)userPwd(111)auto(1)“口

20、；如果需要设置服务器地址或端口UIApplication sharedApplication openURL:NSURL URLWithString: ”FSMeetingClient:/userType(1)userName(hst)userPwd(111)auto(1)svrAddress(7)s vrPort(1089) ”;仅仅启动APPUIApplication sharedApplication openURL:NSURL URLWithString: FSMeetingClient:/ ;Word资料五、Android客户端调用接口调用接口说明参数说明：userName : 用户

21、名userPwd :用户密码svrAddress :服务器地址svrPort ：服务器端口用户名和密码方式登录例如：用户名：hst密码：111ComponentNameapk2Component1=newComponentName(com.fastonz.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTierActivity);Intent mIntent = new Intent();Bundle mBundle = new Bundle();mBundle.putString( userName ”,hst);mBundle.pu

22、tString( userPwd ”,111);mIntent.putExtras(mbundle);mIntent.setComponent(apk2Component1);startActivity(mIntent);如果需要设置服务器地址或端口：ComponentNameapk2Component1=newWord资料ComponentName(com.fastonz.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTie rActivity);Intent mIntent = new Intent();Bundle mBundl

23、e = 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);仅仅启动APPComponentName apk2Component = newComponentName(com.fastonz

24、.fastmeeting,com.fastonz.fastmeeting.ui.StartTheMiddleTie rActivity);Intent intent = new Intent();intent.setComponent(apk2Component);startActivity(intent);六、会控及数据交互接口接口协议接 口调用地址： HYPERLINK http:/localhost:8080/fmws/services/WsService http:/localhost:8080/fmws/services/WsService密钥：Word资料keyCode=fsweb

25、service2011密钥用于对 WebService接口的访问认证，默认为fswebservice2011,访问时需要对密钥进行 MD5加密。接口中出现的keyCode都是fswebservice2011加密后字符串：3025495AEE146DA3864AB81BAAF79A3EWebService 接口功能列表新增用户信息public String regUser(String username,String passpwd,String Nickname,String keyCode)说明：这里的密码(passpwd)是原密码，没有经过 md5加密的。参数参数名中义名字符类型长度是否为

26、空username用户名String64Npasspwd用户密码String16NNickname昵称String32NkeyCode密钥String32N返回值：字符串参考返回码public String regUserMD5ed(String username,String passpwd,StringNickname,String keyCode)说明：这里的密码(passpwd),是原密码经过md5加密后的字符串参数，加密后的passpwd密码长度必须为32位Word资料参数名中义名字符类型长度是否为空username用户名String64Npasspwd用户密码String32NNi

27、ckname昵称String32NkeyCode密钥String32N返回值：字符串参考返回码批量注册用户public String batchRegUser(String preName,int num,String passpwd,StringkeyCode)说明：这里的密码(passpwd),是原密码(没有经过 md5加密的)参数参数名中义名字符类型长度是否为空preName前缀名String5Npasspwd用户密码String16NkeyCode密钥String32N返回值：字符串参考返回码修改用户信息public String editUserinfo(int userid,Str

28、ing username,String passpwd,Stringnickname,String mobile,String email,String keyCode)Word资料说明：这里的密码（passpwd）,是原密码（没有经过 md5加密的）参数参数名中义名字符类型长度是否为空userid用户IDint默认Nusername用户名String64Npasspwd用户密码String16YNickname昵称String32Ymobile手机号码String15Nemail电子邮箱String100NkeyCode密钥String32N返回值：字符串参考返回码public String

29、 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用户密码String32YWord资料Nickname昵称String32Ymobile手机号码

30、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(in

31、t userid,String searchName,String keyCode)参数：参数名中义名字符类型长度是否为空Word资料userid用户IDint默认NsearchName搜索关键字String64YkeyCode密钥String32Nuserid不能为空，如果不使用userid,可以指定为0返回值如：user-jdom.xml里内容6.2.6,新增会议public String addRoominfo（String roomName,String roomType,Stringpassword,String verifyMode,int maxUserCount,String

32、hopeStartTime,StringhopeEndTime,String enableChairPwd,String chairPassword,String keyCode）说明：这里的密码（passpwd）,是原密码（没有经过 md5加密的）参数参数名中文名字符类型长度格式是否为空roomName会议室名String64NroomType会议类型String11:固定会议室（无固定期限，永久有效）；2:预约会议室（后开始和结束时间）；3:临时 会议室（会议室创建 24小时之后，如果会 议室内没有人，该会议室会自动删除）Npassword密码String16YverifyMode登录校验

33、模 型String11、用户密码验证；2、会议室密码验证；3、 匿名登录NmaxUserCou nt允许最大用 户数int默认NhopeStartTi me预定开始时 间String20yyyy-mm-dd HH:mm:ss 丫hopeEndTim e预定结束时 间String20yyyy-mm-dd HH:mm:ss YenableChairPwd是否允许主 席密码String1YchairPasswor d主席密码String16YkeyCode密钥String32采用MD5加密Word资料返回值：新增会议室ID。如果返回值10000,表示发生错误，返回错误码通过会议室给用户授权publi

34、c String doUserRightbyUserName(String arrUserNameandRight,int roomId,String keyCode)参数参数名中文名字符类型长度是否为空arrUserNameandRight需要改变的内容String2147483647NroomID会议IDint默认NkeyCode密钥String32N返回值：字符串参考返回码arrUserNameandRight 格式说明：用户名(userName)权BM值(UserRight)# 用 户名(userName)权BM值(UserRight)权限值定义：1旁听2出席3主持权限值为空或为0时，

35、表示取消该用户会议室权限通过用户名给会议授权publicStringdoRoomRightByUserName(StringarrRoomIdandRight,String userName,String keyCode)参数参数名中文名字符类型长度是否为空arrRoomIdandRight需要改变的内容String2147483647NuserName用户名String默认NkeyCode密钥String32N返回值：字符串参考返回码arrRoomIdandRight 格式说明：会议 ID(roomId) 权限值(UserRight)# 会议Word资料ID(roomld)权BM值(User

36、Right)删除会议室public String delRoom(int roomID,String keyCode)参数参数名中义名字符类型长度是否为空roomID会议IDint默认NkeyCode密钥String32N返回值：字符串参考返回码修改会议室信息public String editRoominfo(int roomid,String roomName,StringroomType,String password,String verifyMode,int maxUserCount,StringhopeStartTime,StringhopeEndTime,String enableChairPwd,StringchairPassword,String keyCode)说明：这里的密码（passpwd）,是原密码（没有经过 md5加密的）参数参数名中义名字符类型长度是否为空roomid前缀名String5N or YroomName用户密码String16N or YroomType会议类型String11:固定会议室（无固定期限，永久启效）；2:Word资料预约会议室（有开始和结束时间）Npassword密码String16YverifyMode登录校验模型Stri