本指南為入門性質(zhì)，方便項(xiàng)目管理人員了解相關(guān)流程和基本原理，負(fù)責(zé)集成工作的技術(shù)人員，需要詳細(xì)預(yù)約下面的API文檔，以及SDK中的UserGuide文檔。
資料下載
API文檔下載
https://down.bizvideo.cn/app/bizconf/open/api_bingfa.docx?
Pro APP下載
https://pro.bizvideo.cn/support/download
SDK下載
http://www.itdecent.cn/p/febfc71d0abb
集成概述
會(huì)暢提供的API，一般不建議客戶的APP直接訪問(wèn)。建議客戶用自己的web服務(wù)器訪問(wèn)會(huì)暢API預(yù)約會(huì)議，然后將預(yù)約成功的信息轉(zhuǎn)給APP，同時(shí)在自己的數(shù)據(jù)庫(kù)中保存。
準(zhǔn)備工作
方案1. 如果您采用API預(yù)約會(huì)議，調(diào)用Pro APP參加會(huì)議的方式，只需要由商務(wù)代表為您申請(qǐng)開(kāi)通站點(diǎn)，提供sitesign和API key，即可啟動(dòng)研發(fā)工作。
方案2. 如果您采用API預(yù)約會(huì)議，調(diào)用SDK，在您自己的APP中參加會(huì)議的方式，那么需要由商務(wù)代表為您申請(qǐng)開(kāi)通站點(diǎn)，提供sitesign和API key，以及channel ID和 SDK key，方可啟動(dòng)研發(fā)工作。
API傳參說(shuō)明
傳參格式為application/x-www-form-urlencoded，不能用json格式傳參。否則會(huì)返回109錯(cuò)誤。
userId：一般建議填您的系統(tǒng)中的這個(gè)用戶的ID。假設(shè)您的APP是一個(gè)OA系統(tǒng)，那么可以傳您給用戶定義的OA賬號(hào)ID；長(zhǎng)度一般不超過(guò)32個(gè)字符。
username：是會(huì)中顯示的名字，也建議您傳您系統(tǒng)中的用戶昵稱，和APP保持一致。
token根據(jù)手冊(cè)中的方法，生成大寫的32位MD5值，即MD5(“userId|APIKey|timeStamp”)；
timestamp是毫秒，不要用秒，請(qǐng)注意
sitesign是商務(wù)代表幫您申請(qǐng)的二級(jí)站點(diǎn)的前綴。比如，二級(jí)站點(diǎn)為huawei.bizvideo.cn，那么這里就填“huawei”，必須一字不差！?
starttime是GMT時(shí)間，也就是北京時(shí)間減掉8小時(shí)。格式必須是“2019-01-03
07:00:00”。
confParties：會(huì)議申請(qǐng)占用的并發(fā)數(shù)量。比如您預(yù)計(jì)本場(chǎng)會(huì)議約有50人參加，則可以傳50.系統(tǒng)會(huì)為您保留50個(gè)并發(fā)資源，保證會(huì)議開(kāi)始后50個(gè)參會(huì)人可以順利加入。如果會(huì)議開(kāi)始后，發(fā)現(xiàn)50并發(fā)不夠，屆時(shí)可以通過(guò)《2.14 會(huì)中修改會(huì)議》接口臨時(shí)擴(kuò)容。
注意事項(xiàng)
timestamp和token都是一次性的，用一次，下次就要換一個(gè)值！
confPassword是會(huì)議密碼，長(zhǎng)度不可超過(guò)10位！
token要大寫！
主持人如何開(kāi)啟會(huì)議
會(huì)議預(yù)約成功后，返回值中會(huì)有hostStartUrl和protocolHostStartUrl兩個(gè)字段。
如果您采用的集成方式是方案1（API+Pro APP），可以通過(guò)瀏覽器打開(kāi)hostStartUrl，進(jìn)入到一個(gè)啟會(huì)頁(yè)面，該頁(yè)面會(huì)自動(dòng)調(diào)起Pro APP開(kāi)會(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），可以通過(guò)瀏覽器打開(kāi)joinURL，進(jìn)入到一個(gè)啟會(huì)頁(yè)面，該頁(yè)面會(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)連接語(yǔ)音，傳NO，則需要用戶手動(dòng)連接語(yǔ)音（可以自由選擇接入方式，比如VoIP，電話呼入，外呼）。isvideo如果傳YES，則在進(jìn)入會(huì)議后，攝像頭默認(rèn)是開(kāi)著的（前提是web在預(yù)約會(huì)議時(shí)，optionVideoParticipants傳了1。否則即使此項(xiàng)傳YES，進(jìn)入會(huì)議后攝像頭也是關(guān)閉狀態(tài)）。
如果您要給參會(huì)人指定一個(gè)姓名，在protocolJoinUrl后面追加&uname=XXX就可以了。
