Pro賬號(hào)模式集成指南

本指南為入門性質(zhì)，方便項(xiàng)目管理人員了解相關(guān)流程和基本原理，負(fù)責(zé)集成工作的技術(shù)人員鹊漠，需要詳細(xì)預(yù)約下面的API文檔，以及SDK中的UserGuide文檔茶行。

資料下載

API文檔下載

https://down.bizvideo.cn/app/bizconf/open/api_zhanghao.docx?

Pro APP下載

https://pro.bizvideo.cn/support/download

SDK下載

http://www.reibang.com/p/febfc71d0abb

集成概述

會(huì)暢提供的API躯概，一般不建議客戶的APP直接訪問。建議客戶用自己的web服務(wù)器訪問會(huì)暢API預(yù)約會(huì)議畔师，然后將預(yù)約成功的信息轉(zhuǎn)給APP娶靡，同時(shí)在自己的數(shù)據(jù)庫中保存。

準(zhǔn)備工作

方案1. 如果您采用API預(yù)約會(huì)議看锉，調(diào)用Pro APP參加會(huì)議的方式姿锭，只需要由商務(wù)代表為您申請(qǐng)開通站點(diǎn)，提供sitesign和API key伯铣，即可啟動(dòng)研發(fā)工作呻此。

方案2. 如果您采用API預(yù)約會(huì)議，調(diào)用SDK懂傀，在您自己的APP中參加會(huì)議的方式趾诗，那么需要由商務(wù)代表為您申請(qǐng)開通站點(diǎn)，提供sitesign蹬蚁，API key，以及channel ID和 SDK key郑兴，方可啟動(dòng)研發(fā)工作犀斋。

API傳參說明

在使用預(yù)約接口的時(shí)候，有如下幾點(diǎn)需要注意：

1. userId我們沒有要求情连，一般建議填您的系統(tǒng)中的這個(gè)用戶的ID叽粹。假設(shè)您的APP是一個(gè)OA系統(tǒng)，那么可以傳您給用戶定義的OA賬號(hào)ID却舀；長度一般不超過32個(gè)字符虫几。

2. username是會(huì)中顯示的名字，也建議您傳您系統(tǒng)中的用戶昵稱挽拔，和APP保持一致辆脸。

3. token根據(jù)手冊(cè)中的方法，生成大寫的32位MD5值螃诅，即MD5(“userId|APIKey|timeStamp”)啡氢；

4. timestamp是毫秒状囱，不要用秒，請(qǐng)注意

5. sitesign是商務(wù)代表幫您申請(qǐng)的二級(jí)站點(diǎn)的前綴倘是。比如亭枷，二級(jí)站點(diǎn)為huawei.bizvideo.cn，那么這里就填“huawei”搀崭，必須一字不差叨粘！

6. starttime是GMT時(shí)間，也就是北京時(shí)間減掉8小時(shí)瘤睹。格式必須是“2019-01-03 07:00:00”升敲。

7. confParties要填根據(jù)實(shí)際情況填寫，站點(diǎn)的會(huì)議室資源可能大小不一默蚌，有10方冻晤，25方等。您通過API文檔中的“2.5 獲取會(huì)議室方數(shù)類型 getRoomPartiesBySiteSign “方法绸吸，可以獲取到所有的可用選項(xiàng)鼻弧。填任何一個(gè)都可以，可以讓用戶在界面上去選擇一下锦茁，也可以根據(jù)自己的情況自動(dòng)分配攘轩。不能隨便填，否則可能會(huì)收到205錯(cuò)誤码俩。

8. upCompatible可以不填度帮，不填的意思就是嚴(yán)格按照您指定的confParties來分配會(huì)議室。它的含義是稿存，如果您填的confParties是10笨篷，但是10方的會(huì)議室預(yù)約滿了，那么會(huì)預(yù)約到25方瓣履，50方等更大的會(huì)議室率翅。

9. timestamp和token都是一次性的，用一次袖迎，下次就要換一個(gè)值冕臭。

10. confPassword是會(huì)議密碼，長度不可超過10位燕锥。

11.?傳參格式為application/x-www-form-urlencoded辜贵，不能用json格式傳參。否則會(huì)返回109錯(cuò)誤归形。

12. 最后托慨，這是一次預(yù)約請(qǐng)求的sample，供參考连霉。

預(yù)約會(huì)議傳參范例

主持人如何開啟會(huì)議

會(huì)議預(yù)約成功后榴芳，返回值中會(huì)有hostStartUrl和protocolHostStartUrl兩個(gè)字段嗡靡。

如果您采用的集成方式是方案1（API+Pro APP），可以通過瀏覽器打開hostStartUrl窟感，進(jìn)入到一個(gè)啟會(huì)頁面讨彼，該頁面會(huì)自動(dòng)調(diào)起Pro APP開會(huì)。

如果您采用的集成方案是方案2（API+SDK）柿祈，需要調(diào)用SDK中的startMeeting接口哈误，具體用法如下（以iOS端為例）：

- (void)startMeeting:(NSString *)protocol

needRemind:(BOOL)needRemind

result:(void (^)(BizSDKMeetError))completion;

參數(shù)解釋

protocol就填web返回的protocolHostStartUrl，包含了會(huì)議號(hào)躏嚎，身份認(rèn)證等所有信息蜜自。needRemind如果傳YES，那么在會(huì)議結(jié)束前10分鐘卢佣，會(huì)彈框提示用戶“會(huì)議即將結(jié)束”重荠，以避免超出時(shí)間后，和其他的會(huì)議沖突虚茶。

參會(huì)人如何參加會(huì)議

會(huì)議預(yù)約成功后戈鲁，返回值中會(huì)有joinURL和protocolJoinUrl兩個(gè)字段。

如果您采用的集成方式是方案1（API+Pro APP）嘹叫，可以通過瀏覽器打開joinURL婆殿，進(jìn)入到一個(gè)啟會(huì)頁面，該頁面會(huì)自動(dòng)調(diào)起Pro APP參會(huì)罩扇。如果您希望給參會(huì)人指定一個(gè)姓名婆芦，在joinURL后面追加?uname=XXX就可以了。

如果您采用的集成方案是方案2（API+SDK）喂饥，需要調(diào)用SDK中的joinMeeting接口消约，具體用法如下（以iOS端為例）：

- (void)joinMeeting:(NSString *)protocolJoinUrl

isAudio:(BOOL)audio

isvideo:(BOOL)video

result:(void(^)(BizSDKMeetError))completion;

參數(shù)解釋

protocol就填web返回的protocolJoinUrl，包含了會(huì)議號(hào)员帮，參會(huì)密碼等所有信息荆陆。isAudio如果傳YES，那么在進(jìn)入會(huì)議后集侯，自動(dòng)連接語音，傳NO帜消，則需要用戶手動(dòng)連接語音（可以自由選擇接入方式棠枉，比如VoIP，電話呼入泡挺，外呼）辈讶。isvideo如果傳YES，則在進(jìn)入會(huì)議后娄猫，攝像頭默認(rèn)是開著的（前提是web在預(yù)約會(huì)議時(shí)贱除，optionVideoParticipants傳了1生闲。否則即使此項(xiàng)傳YES，進(jìn)入會(huì)議后攝像頭也是關(guān)閉狀態(tài)）月幌。

如果您要給參會(huì)人指定一個(gè)姓名碍讯，在protocolJoinUrl后面追加&uname=XXX就可以了。