更新時(shí)間:2019-11-20
接口名稱 |
接口描述 |
---|---|
獲取呼叫對(duì)象。 |
|
發(fā)起一路呼叫。 |
|
應(yīng)答或拒絕呼叫。 |
|
主動(dòng)掛斷呼叫。 |
|
在通話中發(fā)送二次撥號(hào)信息,每調(diào)用一次發(fā)送一次信號(hào)。 |
|
音視頻通話相互轉(zhuǎn)換。 |
|
接受或拒絕音頻轉(zhuǎn)視頻請(qǐng)求。 |
|
兩方通話轉(zhuǎn)多方會(huì)議。 |
|
獲取指定媒體類型的設(shè)備序號(hào)列表。 |
|
設(shè)置指定媒體類型的設(shè)備的序號(hào)。 |
|
設(shè)置麥克或揚(yáng)聲器的音量。 |
|
獲取麥克或揚(yáng)聲器音量。 |
|
播放媒體鈴聲。 |
|
停止播放媒體鈴聲。 |
|
獲取呼叫統(tǒng)計(jì)信息。 |
接口描述
獲取呼叫對(duì)象。
注意事項(xiàng)
無(wú)。
方法定義
getCallHandler(): any |
參數(shù)描述
無(wú)。
返回值
類型 |
描述 |
---|---|
any |
Call對(duì)象。 |
代碼示例
var cloudecGetCallHandler = function () { var call= client.getCallHandler(); if (call== null) { return; } } |
接口描述
發(fā)起一路呼叫。
注意事項(xiàng)
無(wú)。
方法定義
makeCall(calleeNumber: string, isVideo:boolean, callback: Function):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
calleeNumber |
是 |
string |
被叫號(hào)碼,最大長(zhǎng)度127字節(jié)。 |
isVideo |
是 |
boolean |
是否為視頻呼叫。
|
callback |
是 |
Function |
回調(diào)函數(shù),返回操作結(jié)果。 |
返回值
無(wú)。
代碼示例
function makeCall(){ var isVideoCall = 0; var calleeNum = document.getElementById("callee_num").value; if(document.getElementById("isVideoCall").checked) { isVideoCall = 1; } client.makeCall(calleeNum, isVideoCall,function(data){ if(data.result){ document.getElementById("callState").innerHTML = "call state: make call"; } }); } |
接口描述
應(yīng)答或拒絕呼叫。
注意事項(xiàng)
需在來(lái)電事件之后調(diào)用,否則失敗。
方法定義
answerCall(accept:boolean, isVideo:boolean):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
accept |
是 |
boolean |
是否應(yīng)答呼叫。
|
isVideo |
是 |
boolean |
是否視頻接聽(tīng)。
|
返回值
無(wú)。
代碼示例
function answerCall(accept){ var call = client.getCallHandler(); if (call == null) { return; } var isVideo = document.getElementById("isVideoCall").checked; client.answerCall(accept, isVideo); } |
接口描述
主動(dòng)掛斷呼叫。
注意事項(xiàng)
通話雙方均可以調(diào)用此接口掛斷呼叫。
方法定義
hangup():void |
參數(shù)描述
無(wú)。
返回值
無(wú)。
代碼示例
function hangup(){ var call = client.getCallHandler(); if (call == null) { return; } client.hangup(); } |
接口描述
一些業(yè)務(wù)場(chǎng)景中,用戶需要通過(guò)終端按鍵與網(wǎng)絡(luò)進(jìn)行交互,如充值、撥打總機(jī)后再撥打分機(jī)號(hào)碼、撥打客服中心號(hào)碼等。本接口用于在通話中發(fā)送二次撥號(hào)信息,每調(diào)用一次發(fā)送一次信號(hào)。
注意事項(xiàng)
方法定義
sendDTMF(dtmfNo: string):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
dtmfNo |
是 |
string |
DTMF鍵值,取值范圍0~16。 |
返回值
無(wú)。
代碼示例
function DTMF(dtmfNo){ var call = client.getCallHandler(); if (call == null) { return; } client.sendDTMF(dtmfNo); } |
接口描述
音視頻通話相互轉(zhuǎn)換。
注意事項(xiàng)
處于通話中才可以調(diào)用此接口。
方法定義
switchAudioCall(toAudioCall:boolean):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
toAudioCall |
是 |
boolean |
音視頻轉(zhuǎn)換。
|
返回值
無(wú)。
代碼示例
function addVideo(){ var call = client.getCallHandler(); if (call == null) { return; } client.switchAudioCall(false); } function delVideo(){ var call = client.getCallHandler(); if (call == null) { return; } client.switchAudioCall(true); } |
接口描述
接受或拒絕音頻轉(zhuǎn)視頻請(qǐng)求。
注意事項(xiàng)
處于通話中才可以調(diào)用此接口。
方法定義
answerSwitch(accept:boolean):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
accept |
是 |
boolean |
是否接受音頻轉(zhuǎn)視頻。
|
返回值
無(wú)。
代碼示例
function replyAddVideo(accept){ var call = client.getCallHandler(); if (call == null) { return; } client.answerSwitch(accept); } |
接口描述
兩方通話轉(zhuǎn)多方會(huì)議。
注意事項(xiàng)
無(wú)。
方法定義
transfer2Conf(confParam: EC_InstanceConfParam):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
confParam |
是 |
會(huì)議參數(shù)。 |
返回值
無(wú)。
代碼示例
function transfer2Conf(){ var call = client.getCallHandler(); if (call == null) { return; } var memberList = document.getElementById("memberList").value; if(memberList!=undefined && memberList!=null && memberList!=""){ var memberListArr = memberList.split(","); var memberListTemp = new Array(); for (var i = 0; i < memberListArr.length; i++) { memberListTemp[i] = { number: memberListArr[i], name: "", smsPhone: "", email: "", autoInvite: 1, role: 0,extensions: "" }; } transfer2ConfParam = { attendees: memberListTemp } }else{ transfer2ConfParam=null; } client.transfer2Conf(transfer2ConfParam); } |
接口描述
獲取指定媒體類型的設(shè)備序號(hào)列表。
注意事項(xiàng)
無(wú)。
方法定義
getMediaDevice(deviceType: number, callback: Function): void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
deviceType |
是 |
number |
設(shè)備類型。 0:麥克 1:揚(yáng)聲器 2:攝像頭 |
callback |
是 |
Function |
回調(diào)函數(shù),獲取媒體設(shè)備返回結(jié)果。失敗提示相應(yīng)錯(cuò)誤信息請(qǐng)參考EC_ErrorInfo,成功返回的結(jié)果參考EC_MediaDevices。 |
返回值
無(wú)。
代碼示例
client.getMediaDevice(2, function (data) { if (data.info != null) { for (var i = 0; i < data.info.length; i++) { console.log("camera device:" + data.info[i].name)); } } }); |
接口描述
設(shè)置指定媒體類型的設(shè)備的序號(hào)。
注意事項(xiàng)
無(wú)。
方法定義
setMediaDevice(deviceType: number, index: number): void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
deviceType |
是 |
number |
設(shè)備類型。 0:麥克 1:揚(yáng)聲器 2:攝像頭 |
index |
是 |
number |
序號(hào),來(lái)自于getMediaDevice的查詢結(jié)果。 |
返回值
無(wú)。
代碼示例
var micSel = document.getElementById("MICDevice"); var selIndex = micSel.selectedIndex; if (selIndex !== -1) { var micIndex = micSel.options[selIndex].value; client.setMediaDevice(0, parseInt(micIndex)); } |
接口描述
設(shè)置麥克或揚(yáng)聲器的音量。
注意事項(xiàng)
調(diào)用后需要切換UI界面。
方法定義
setVoiceVol(deviceType: number, value: number): void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
deviceType |
是 |
number |
設(shè)備類型。 0:麥克 1:揚(yáng)聲器 |
value |
是 |
number |
音量值,取值范圍[0,100]。 |
返回值
無(wú)。
代碼示例
var micvol = document.getElementById("MICVol"); client.setVoiceVol(0, parseInt(micvol.value)); |
接口描述
獲取麥克或揚(yáng)聲器音量。
注意事項(xiàng)
必須先通過(guò)getMediaDevice確認(rèn)是否有麥克或揚(yáng)聲器設(shè)備,否則報(bào)錯(cuò)。
方法定義
getVoiceVol(deviceType: number, callback: Function): void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
deviceType |
是 |
number |
設(shè)備類型。 0:麥克 1:揚(yáng)聲器 |
callback |
是 |
Function |
回調(diào)函數(shù),返回麥克或揚(yáng)聲器音量。 |
返回值
無(wú)。
代碼示例
client.getVoiceVol(1, function (data) { speakervol.value = data.info; }) |
接口描述
播放媒體鈴聲。
注意事項(xiàng)
無(wú)。
方法定義
startPlayMedia(loops:number, playFile:string, callback: Function):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
loops |
是 |
number |
循環(huán)播放次數(shù)(0則表示一直循環(huán))。 |
playFile |
是 |
string |
播放文件的路徑(若填寫相對(duì)路徑,則該路徑的起始目錄為CloudLinkMeetingDeamon安裝目錄),最大長(zhǎng)度127字節(jié)。 |
callback |
是 |
Function |
回調(diào)函數(shù),返回操作結(jié)果。 |
返回值
無(wú)。
代碼示例
var playHandle; function startPlayMedia(){ var mediaFilePath = document.getElementById("media_file_path").value; client.startPlayMedia(0, mediaFilePath,function(data){ if(data.result){ playHandle = data.info.playHandle; } }); } |
接口描述
停止播放媒體鈴聲。
注意事項(xiàng)
有鈴聲正在播放才可調(diào)用此接口,否則報(bào)錯(cuò)。
方法定義
stopPlayMedia(handle:number):void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
handle |
是 |
number |
停止播放媒體鈴聲的句柄。 |
返回值
無(wú)。
代碼示例
function stopPlayMedia(){ client.stopPlayMedia(playHandle); } |
接口描述
獲取呼叫統(tǒng)計(jì)信息。
注意事項(xiàng)
無(wú)。
方法定義
getCallStatisticInfo(callback: Function) :void |
參數(shù)描述
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
callback |
是 |
Function |
回調(diào)函數(shù),成功返回呼叫統(tǒng)計(jì)信息EC_CallStatisticInfo,失敗返回錯(cuò)誤信息。 |
返回值
無(wú)。
代碼示例
function getCallStatisticInfo(){ client.getCallStatisticInfo(function(data){ console.log(JSON.stringify(data)); }); } |