Pro账号模式集成指南

本指南为入门性质,方便项目管理人员了解相关流程和基本原理,负责集成工作的技术人员,需要详细预约下面的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就可以了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,552评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,666评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,519评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,180评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,205评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,344评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,781评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,449评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,635评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,467评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,515评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,217评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,775评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,851评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,084评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,637评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,204评论 2 341