ubi移动会议接口系统

1、目录一.接口说明31.会议部分32.登录部分83.公司部分10部门部分12用户部分13错误码参考14二.接口调用流程说明161、创建会议162、登录会议接口调用163、用户系统与会议系统接口调用关系图17一.接口说明1.会议部分接口名称预议接口 URL地址:端/apis/meeting_create.接口功能预议参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）UserID用户名会议系统的用户, 选填Password用户会议系统的用户, 选填MeetingName会议名必填StartTime会议开始时间必填, 例：2011-07-14EndT

2、ime会议结束时间必填, 例：2011-07-31ChairmanPWD必填，4=长度=20PasswordRequired会议是否需要普通00:否、1:是ConfUsWD会议普通用户PasswordRequired = 1 时必填IsRegisterUser是否允许非用户参加10:否、1:是AllowSidelineUser是否允许旁听用户参加00:否、1:是SidelineUsWD旁听用户AllowSidelineUser = 1 时必填ConfUserNum普通用户数SidelineUserNum旁听用户数Max最大数MaxAudio最大音频数MeetingInfo会议描述Type分辨率

3、20：160*120；1：174*144；2：320*2403：352*288；4：640*480；5：720*5766：640*360；7：960*540；8：1280*7209：1920*1080MeetingLayout会议布局参数10：数据布局；1：综合布局；2：布局AudioMode音频模式00：表示 speex 语音；1：宽带音频2：中等质量音频；3：窄带音频meetingusertype参会的用户类型10Flash 用户 Ipad 用户encode编码00：h.264 编码1: h.263 编码返回值此方法若调用成功则会返回 json 数据： sus:2000,serial:会议

4、号可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码, 请查看相应错误码表。举例tingName=test&StartTime=2013-03-01&EndTime=2013-03-20&ChairmanPWD=123456tingName=test&StartTime=2013-03-01&EndTime=2013-03-20&ChairmanPWD=123456&PasswordRequired=1&Conf Us WD=111111&IsRegisterUser=0&AllowSidelineUser=1&SidelineUs WD=222222&ConfUserNu

5、m=6&Sidelin eUserNum=3&Max =2&MaxAudio=2&MeetingInfo=uuuu& Type=4&MeetingLayout=2&AudioMode=0&meetin gusertype=10& encode=1返回数据sus:2000,serial:720888接口名称删除会议接口 URL地址:端/apis/meeting_delete.接口功能删除会议参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）Serial会议必填返回值此方法若调用成功则会返回 json 数据：sus:2000,serial:会议号

6、可根据sus 是否是 2000 来判断是否成功接口名称修改会议接口 URL地址:端/apis/meeting_modify.接口功能修改会议参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）Serial会议必填MeetingName会议名必填StartTime会议开始时间必填, 例：2011-07-14EndTime会议结束时间必填, 例：2011-07-31ChairmanPWD必填，4=长度=20PasswordRequired会议是否需要普通00:否、1:是 , 必填ConfUsWD会议普通用户PasswordRequired = 1

7、时必填IsRegisterUser是否允许非用户参加10:否、1:是AllowSidelineUser是否允许旁听用户参加00:否、1:是SidelineUsWD旁听用户AllowSidelineUser = 1 时必填ConfUserNum普通用户数SidelineUserNum旁听用户数Max最大数MaxAudio最大音频数MeetingInfo会议描述Type分辨率0：160*120；1：174*144；2：320*2403：352*288；4：640*480；5：720*5766：640*360；7：960*540；8：1280*7209：1920*1080MeetingLayout会

8、议布局参数0：数据布局；1：综合布局；2：布局AudioMode音频模式0：表示 speex 语音；1：宽带音频2：中等质量音频；3：窄带音频meetingusertype参会的用户类型Flash 用户 Ipad 用户encode编码0：h.264 编码1: h.263 编码返回值此方法若调用成功则会返回 json 数据：sus:2000,serial:会议号可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例MeetingName=test1&StartTime=2012-03-01&EndTime=2012-03-20&ChairmanPWD=123456返回数据s

9、us:2000,serial:720888接口名称得到某个时间范围内的会议接口 URL地址:端/apis/meeting_getbytime.接口功能根据某个时间范围，得到会议列表参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）starttime会议开始时间必填, 例：2011-07-14endtime会议结束时间9999-12-31返回值此方法若调用成功则会返回 json 数据：s us:2000, serial:会议号,meetingname:会议名称,starttime:开始时间,endtime:结束时间,chairmanpwd:,confus

10、 wd:普通用户会议 ,sidelineus wd:旁听用户会议 可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,serial:248190,meetingname:asdfsa,starttime:2012-03-2110：30,endtime:2999-12-3112：30,chairmanpwd:3898,confuswd:,sidelineuswd:,sus:2000,meetingid:20,serial:532187,meetingname:asdfas,starttime:2012-03-21,endtime:2999-12-

11、31,chair接口名称得到会议列表接口 URL地址:端/apis/meeting_list.接口功能得到会议列表参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）meetingtype会议类型00:表示全部会议1：表示当前会议2：未来会议3：历史会议返回值此方法若调用成功则会返回 json 数据：sus:2000, serial:会议号,meetingname:会议名称,starttime:开始时间,endtime:结束时间,realname: 用户名,chairmanpwd:,confuswd: 普通用户会议 ,sidelineuswd:旁听用户会

12、议可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,serial:248190,meetingname:asdfsa,starttime:2012-03-21 15:54,endtime:2999-12-3123:59,realname:admin,chairmanpwd:3898,confuswd:,sidelineuswd:,sus: 2000,meetingid:25,serial:613832,meetingname:eeeeee,starttime:2012-03-21 17:01,endtime:2999-12-3123:59,r

13、ealname:admin,chairmanpwd:6639,confuswd:,sidelineuswd:若调用失败,会返回错误码。举例返回数据sus:2000,serial:720888接口名称得到会议的登入登出信息接口 URL地址:端/apis/login_list.接口功能得到会议的登入登出信息（每次最多取 100 条数据）参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号必填startnum起始数1Endnum结束数100接口名称得到会议的聊答信息接口 URL地址:端/apis/chat_list.接口功能得到会议的聊天信息

14、参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号必填chattype聊天的类型00:公聊 1:问答 2:私聊startnum起始数1endnum结束数100chatname聊天人返回值此方法若调用成功则会返回 json 数据：sus:2000,name_1:名字,name_2:名字,chattime:时间,content:内容可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,name_1:admin,name_2:a1,chattime:2013-01-12 08:00:00,co

15、ntent:uyyuyuyyuuu接口名称得到某个会议的详细信息接口 URL地址:端/apis/meeting_get.接口功能根据会议 ID，得到某个会议的详细信息参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号返回值此方法若调用成功则会返回 json 数据：s us:2000, serial:会议号,meetingname:会议名称,starttime:开始时间,endtime:结束时间,chairmanpwd:,confus wd:普通用户会议 ,sidelineus wd:旁听用户会议 可根据sus 是否是 2000 来判断

16、是否成功若调用失败,会返回错误码。举例返回数据sus:2000,serial:572918,meetingname:aaa,starttime:2013-01-10 15:36,endtime:2999-12-3123:59,chairmanpwd:6128,confuswd:,sidelineuswd:manpwd:8551,confuswd:,sidelineuswd:接口名称获取会议用户数接口 URL地址:端/apis/meeting_online.接口功能获取服务器用户数参数参数名参数说明缺省值备注Key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号选填，

17、如果填写就表示获取某个会议的在线人数，如果不填就表示获取全部会议的接口名称设置在会议中显示的url接口 URL地址:端/apis/meeting_relaurl.接口功能设置在会议中显示指定的url参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号必填linkname显示 URL 名字linkurlurl 地址返回值可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例link接口名称会议文档上传接口 URL地址:端/uplohp接口功能给某个会议上传文档，要求在登陆会议前上传文档参数参数名参数说明缺省值备注ke

18、y预置 key必填（预设：5NIWjlgmvqwbt494）meetingid会议 id二选一必填serial会议号二选一必填sender发送者必填conver是否转换必填要求 type=file 的文件名是 Filedata返回值此方法若调用成功则会返回 json 数据：文件名|文件页数|文件 id|若调用失败,会转换失败。举例Testuplodfile.测试用例成功返回 uploadfiles/20120515_084809_RVNBDIRK.png|1|129|loginname登陆人返回值此方法若调用成功则会返回 json 数据：sus:2000,username:名字,enterti

19、me:登入时间 ,outtime:登出时间,reguser:null,ip:ip 地址可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,username:admin,entertime:2013-01-1208:00:00,outtime:2013-01-15 14:00:00,reguser:null,ip:192.168.0.88接口名称得到待参加会议列表信息接口 URL地址:端/apis/ meeting_getuserbymid.接口功能根据用户 id 得到待参加会议列表信息参数参数名参数说明缺省值备注Key预置 key必填（预设：5

20、NIWjlgmvqwbt494）serial会议号选填，如果填写就表示获取某个会议的在线人数，如果不填就表示获取全部会议的人数返回值此方法若调用成功则会返回 json 数据：sus:2000,info:userid:用户 id1,account:用户帐号 1,userid:用户 id2,account:用户帐号 2可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,info: userid :6, account :test1, userid :8, account :wangliqiang接口名称得到参会用户信息接口 URL地址:端/apis

21、/ meeting_getuserbymid.接口功能根据会议 id 得到参会用户信息参数参数名参数说明缺省值备注Key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议号选填，如果填写就表示获取某个会议的在线人数，如果不填就表示获取全部会议的人数返回值此方法若调用成功则会返回 json 数据：sus:2000,info:userid:用户 id1,account:用户帐号 1,userid:用户 id2,account:用户帐号 2可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,info: userid :6, a

22、ccount :test1, userid :8, account :wangliqiang人数返回值此方法若调用成功则会返回 json 数据：sus:2000,num:serial:会议1,num:人数 2,serial:会议2,num:人数 2可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000,num:serial:129192,num:0,serial:572918,num:02.登录部分接口名称创建以及加入会议；直接进入会议接口 URL地址:端/entry.接口功能用户可以通过此接口从第系统跳转到会议系统，从而实现创建会议、加入会议的动

23、作参数参数名参数说明缺省值备注serial会议必填，会议号，非 0 开始的数字串(6 位或者 8 位)username用户名必填，用户在会议中显示的名称；使用UTF8 编码，特殊字符需使用 urlencode转义接口名称登录会议（用户浏览器）接口 URL地址:端/apis/meet.接口功能登录会议参数参数名参数说明缺省值备注loginkey登录 key来自 登录会议（服务器）返回值，serial会议必填返回值成功直接进入会议，无返回值；若调用失败,会返回错误码。此接口由客户端调用，loginkey 为 open_login.接口获得，loginkey 参数所使用的凭据为有效举例2返回值无接口

24、名称获取会议登陆地址（服务器端调用）接口 URL地址:端/apis/open_login.接口功能登录会议参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）serial会议必填nickname昵称必填(昵称如果是中文需要进行 UTF8 编码，可使用 urlencode)usertype用户类型0 是普通交互用户，1 是，2 是旁听用户(usertype 优先级比高)mainpw如果会议（PasswordRequired=1）那么可输入相应。meetpwd普通用户sidelinepwd旁听用户返回值此方法若调用成功则会返回 json 数据：sus:200

25、0,loginkey: 登录key可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。第系统将此loginkey 交给客户端作为登录的凭证使用，此凭证有效。见下meet.接口。举例1返回值sus:2000,url:/apis/meet/9ed0006f16025e1b507795ca5da946529c969dcd/892322/接口名称登录会议（直接启动客户端进入会议）接口 URLubi:/服务器 ip 地址:服务器 web 端口/会议号/用户名/1(用户类型)/会议类型/im 的(会议没用)/会议序列号/IM 窗口句柄接口功能登录会议参数参数名(参数说明)缺省值备注会议

26、号会议号:填写为 0用户在会议中显示的名称会议用户类型0 表示普通用户 1 表示,2 表示旁听用户会议类型填写为 0im 的填写为 0会议序列号会议序列号:就是在管理系统生成的那个会议号码,或者使用程序调用meeting_create.生成会议的会议IM 窗口句柄IM 窗口句柄:填写为 0返回值成功直接进入会议，无返回值；chairman用户类型必填，0 为普通用户，1 为，2 为旁听用户；默认值为 0；用户 id选填, 第系统的用户 id；默认值为0Ts时间戳必填，当前GMT 时间戳，格式auth必填，auth 值为MD5(key + ts + serial+ username+ chair

27、man)其中 key 为双方协商的接口密钥：默认值为：5NIWjlgmvqwbt494ChairmanPWD选填,；默认值为 0。格式为：128 位 AES 加密串，加密密钥默认为5NIWjlgmvqwbt494companyid公司 id公司 id 或公司两者必填其中一项.公司公司 id 或公司两者必填其中一项.返回值无举例au07e18d0cdbb15303fa9756b0b21784b&ChairmanPWD=E864048BF573B9E5EFA6E2228D7C25panyid=1（会议不存在，创建会议）2c85c759d97261a5cpanyid=1（会议存在，直接进入会议）返回

28、数据进入会议3.公司部分接口名称修改公司接口 URL地址 端pany_modify.接口功能修改公司参数参数名参数说明缺省值备注key预置 key必填（预设：5NIWjlgmvqwbt494）以下信息都是子公司的信息companyid公司 ID必填companyname公司名starttime开始时间endtime结束时间password管理员roomtype类型00：表示试用1：表示正式接口名称增加公司接口 URL地址 端pany_add.接口功能增加公司参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）以下信息都是新增子公司的信息comp

29、anyname公司名必填starttime开始时间必填endtime结束时间必填account公司管理员帐号必填password必填phone号码二选一必填。如果 second不填，自动将phone 作为二级。second二级roomtype类型00：表示试用1：表示正式2:正常到期3:试用到期4:冻结confusernum普通用户数0sidelineusernum旁听用户数0maxaudionum最大音频数0maxnum最大数0返回值此方法若调用成功则会返回 json 数据： sus:2000,companyid:子公司 ID ,authkey:认证 key（子公司认证 key 可根据sus

30、 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例pany_add.?key=5Np11&starttime=2011-08-08&endtime=2011-09-09&account=test&password=111111&phone=123123136&pwdflag=0返回数据sus:2000,companyid:20,authkey:M8hbOIiCFt9DZR接口名称获取公司信息接口 URL地址 端pany_get.接口功能得到某一公司详细信息参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）companyid公司

31、ID(子公司)必填返回值此方法若调用成功则会返回 json 数据：sus:2000,companyid :公司 id,companyname:公司名称 ,account:管理员帐号, starttime :开始时间, endtime :结束时间, confusernum:交互用户数, sidelineusernum :旁听用户数, maxaudionum :最大音频数, maxnum :最大数可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例pany_get.?key=5Npanyid=8返回数据sus:2000,companyid:8,companyname:com

32、12,account:test,starttime:2011-08-08 00:00,endtime:2011-09-0900:00,confusernum:0,sidelineusernum :0,MaxAudioNum:0,MaxNum:0接口名称得到公司下面的所有子公司列表接口 URL地址 端pany_list.接口功能得到公司列表参数参数名参数说明缺省值备注Key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）返回值此方法若调用成功则会返回 json 数据：sus:2000,companyid:8,9,10,11, 可根据sus 是否是 2000 来判断是否成功若调

33、用失败,会返回错误码。举例pany_list.?key=5NIWjlgmvqwbt494返回数据sus:2000,companyid:8,9,10,11,12,13,14,15,16,17,18,19,20,21,2:正常到期3:试用到期4:冻结phone号码second二级confusernum普通用户数sidelineusernum旁听用户数maxaudionum最大音频数maxnum最大数返回值此方法若调用成功则会返回 json 数据：sus:2000 可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例pany_modify.?key=5N12&account=

34、test&password=111111&phone=123123123&userid=16返回数据sus:20004.部门部分接口名称删除部门接口 URL地址:端/apis/department_delete.接口功能删除部门参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）deptid部门 id必填接口名称修改部门接口 URL地址:端/apis/department_modify.接口功能修改部门参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）deptid部门 id必填deptname

35、部门名称必填deptparentid父部门 id必填deptlevel部门级别必填deptpo交互用户数silentpo旁听用户数返回值此方法若调用成功则会返回 json 数据：sus:2000 可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例parentid=1&deptlevel=1返回数据sus:2000 接口名称增加部门接口 URL地址:端/apis/department_add.接口功能增加部门参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）deptid部门 id（必须为大于 5的整形数值）有需要同步用

36、户数据需求的可使用这个参数.但必须保证该参数的唯一性deptname部门名称必填deptparentid父部门 id必填deptlevel部门级别必填deptpo交互用户数silentpo旁听用户数返回值此方法若调用成功则会返回 json 数据：sus:2000,deptid:部门号可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例ptlevel=1返回数据sus:2000,deptid:16 5.用户部分接口名称修改用户接口 URL地址:端/apis/user_modify.接口功能修改用户参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIW

37、jlgmvqwbt494）userid用户 id必填account用户名必填password必填deptid部门 id必填realname真实名字接口名称增加用户接口 URL地址:端/apis/user_add.接口功能增加用户参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）userid用户 id（必须为大于 5 的整型数值）有需要同步用户数据需求的可使用这个参数.但必须保证该参数的唯一性account用户名必填password必填deptid部门 id必填realname真实名字manageroleid在管理系统中的角色se状态gende

38、r0:女1：男pwdflag标识0:明文 1:sha1 加密userother用户 id 不是整型数据时，用这个字段保存用户id ，为了和第保持数据一致返回值此方法若调用成功则会返回 json 数据：sus:2000,userid:用户 ID可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例realname=lhy&manageroleid=3&deptid=4&se=0&gender=0&pwdflag=0返回数据sus:2000,userid:51 返回值此方法若调用成功则会返回 json 数据：sus:2000 可根据sus 是否是 2000 来判断是否成功若调

39、用失败,会返回错误码。举例返回数据sus:2000 6.错误码参考错误码表示4001该公司不存在4002用户名或错误4003会议名称不允许为空4004时间格式错误4005时间设置有误接口名称根据用户 userother 信息获取用户userid接口 URL地址:端/apis/user_getbyothhp接口功能增加用户参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）userother增加用户时传入的userother 信息必填返回值此方法若调用成功则会返回 json 数据：sus:2000,userid:用户 ID可根据sus 是否是 2

40、000 来判断是否成功若调用失败,会返回错误码。举例userother=返回数据sus:2000,userid:51 接口名称删除用户接口 URL地址:端/apis/user_delete.接口功能删除用户参数参数名参数说明缺省值备注key预置 key(调用者)必填（预设：5NIWjlgmvqwbt494）userid用户 id必填返回值此方法若调用成功则会返回 json 数据：sus:2000 可根据sus 是否是 2000 来判断是否成功若调用失败,会返回错误码。举例返回数据sus:2000manageroleid在管理系统中的角色se状态gender0:女1：男updatepwd是否修改0