本指南为入门性质,方便项目管理人员了解相关流程和基本原理,负责集成工作的技术人员,需要详细预约下面的API文档,以及SDK中的UserGuide文档。
资料下载
API文档下载
https://down.bizvideo.cn/app/bizconf/open/api_zhanghao.docx
Pro APP下载
https://pro.bizvideo.cn/support/download
SDK下载
https://www.jianshu.com/p/febfc71d0abb
集成概述
会畅提供的API,一般不建议客户的APP直接访问。建议客户用自己的web服务器访问会畅API预约会议,然后将预约成功的信息转给APP,同时在自己的数据库中保存。
准备工作
方案1. 如果您采用API预约会议,调用Pro APP参加会议的方式,只需要由商务代表为您申请开通站点,提供sitesign和API key,即可启动研发工作。
方案2. 如果您采用API预约会议,调用SDK,在您自己的APP中参加会议的方式,那么需要由商务代表为您申请开通站点,提供sitesign,API key,以及channel ID和 SDK key,方可启动研发工作。
API传参说明
在使用预约接口的时候,有如下几点需要注意:
1. userId我们没有要求,一般建议填您的系统中的这个用户的ID。假设您的APP是一个OA系统,那么可以传您给用户定义的OA账号ID;长度一般不超过32个字符。
2. username是会中显示的名字,也建议您传您系统中的用户昵称,和APP保持一致。
3. token根据手册中的方法,生成大写的32位MD5值,即MD5(“userId|APIKey|timeStamp”);
4. timestamp是毫秒,不要用秒,请注意
5. sitesign是商务代表帮您申请的二级站点的前缀。比如,二级站点为huawei.bizvideo.cn,那么这里就填“huawei”,必须一字不差!
6. starttime是GMT时间,也就是北京时间减掉8小时。格式必须是“2019-01-03 07:00:00”。
7. confParties要填根据实际情况填写,站点的会议室资源可能大小不一,有10方,25方等。您通过API文档中的“2.5 获取会议室方数类型 getRoomPartiesBySiteSign “方法,可以获取到所有的可用选项。填任何一个都可以,可以让用户在界面上去选择一下,也可以根据自己的情况自动分配。不能随便填,否则可能会收到205错误。
8. upCompatible可以不填,不填的意思就是严格按照您指定的confParties来分配会议室。它的含义是,如果您填的confParties是10,但是10方的会议室预约满了,那么会预约到25方,50方等更大的会议室。
9. timestamp和token都是一次性的,用一次,下次就要换一个值。
10. confPassword是会议密码,长度不可超过10位。
11. 传参格式为application/x-www-form-urlencoded,不能用json格式传参。否则会返回109错误。
12. 最后,这是一次预约请求的sample,供参考。
主持人如何开启会议
会议预约成功后,返回值中会有hostStartUrl和protocolHostStartUrl两个字段。
如果您采用的集成方式是方案1(API+Pro APP),可以通过浏览器打开hostStartUrl,进入到一个启会页面,该页面会自动调起Pro APP开会。
如果您采用的集成方案是方案2(API+SDK),需要调用SDK中的startMeeting接口,具体用法如下(以iOS端为例):
- (void)startMeeting:(NSString *)protocol
needRemind:(BOOL)needRemind
result:(void (^)(BizSDKMeetError))completion;
参数解释
protocol就填web返回的protocolHostStartUrl,包含了会议号,身份认证等所有信息。needRemind如果传YES,那么在会议结束前10分钟,会弹框提示用户“会议即将结束”,以避免超出时间后,和其他的会议冲突。
参会人如何参加会议
会议预约成功后,返回值中会有joinURL和protocolJoinUrl两个字段。
如果您采用的集成方式是方案1(API+Pro APP),可以通过浏览器打开joinURL,进入到一个启会页面,该页面会自动调起Pro APP参会。如果您希望给参会人指定一个姓名,在joinURL后面追加?uname=XXX就可以了。
如果您采用的集成方案是方案2(API+SDK),需要调用SDK中的joinMeeting接口,具体用法如下(以iOS端为例):
- (void)joinMeeting:(NSString *)protocolJoinUrl
isAudio:(BOOL)audio
isvideo:(BOOL)video
result:(void(^)(BizSDKMeetError))completion;
参数解释
protocol就填web返回的protocolJoinUrl,包含了会议号,参会密码等所有信息。isAudio如果传YES,那么在进入会议后,自动连接语音,传NO,则需要用户手动连接语音(可以自由选择接入方式,比如VoIP,电话呼入,外呼)。isvideo如果传YES,则在进入会议后,摄像头默认是开着的(前提是web在预约会议时,optionVideoParticipants传了1。否则即使此项传YES,进入会议后摄像头也是关闭状态)。
如果您要给参会人指定一个姓名,在protocolJoinUrl后面追加&uname=XXX就可以了。