更新时间:2022-08-25 GMT+08:00
分享

点对点呼叫1

接口名称

WEB_CallSiteAPI

功能描述

该接口用户发起点对点呼叫或呼叫会议ID。

应用场景

1、已知对方会议号码、IP地址,发起点对点呼叫。

2、已知远端多点会议ID,通过会议ID入会时可以调用该接口入会。如果该远端多点会议有入会密码,需要通过会议鉴权接口:WEB_SendAuthConfPswdAPI 发送会议密码。

3、该接口继承老版本,参数复杂,建议用WEB_CallNumberAPI。

URL

https://ip/action.cgi?ActionID=WEB_CallSiteAPI

参数

表1 点对点呼叫1参数

参数

类型

取值范围

参数说明

bIsVideoCall

int

[0, 1]

是否视频呼叫

0:音频

1:视频

ucEnableH239

int

{0}

固定填0

stSiteInfo

Object

stSiteInfo 对象

参考表2

ulCallRecID

int

[0, 16]

用于回呼,回呼记录id,其他情况默认填0。

ulcallDirecID

int

[0, 1]

默认填0,1表示呼出记录回呼。在呼叫记录回呼时使用。

ulCallPort

int

[0, 1]

用于回呼,默认填0即可。

ucH235Policy

int

{0}

固定填0。

表2 SiteInfo

参数

类型

取值范围

参数说明

szName

string

非空,最大长度192个字节

会议号码、ip 地址或者会场名。

ucType

int

{3, 4, 8, 10}

呼叫类型

3:SIP

4:H.323 PHONE

8:H.323

10:AUTO

szPName

string

可以为空,最大长度192个字节

会场名拼音,建议为空字符串。

stTPS

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stCTS

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stISDN

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stIP

Object

根据呼叫类型填充,见表3

当ucType为AUTO或H.323时使用该对象

stSIP

Object

根据呼叫类型填充,见表3

当ucType为SIP时使用该对象

stV35

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stE1

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stIPOverE1

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stT1

Object

根据呼叫类型填充

当前不支持,填空对象即可。

stPhone

Object

根据呼叫类型填充,见表3

当ucType为H.323 PHONE时使用该对象。

stPSTN

Object

根据呼叫类型填充

当前不支持,填空对象即可。

uwID

int

{0}

固定填0

ucDevice

int

{0}

固定填0

bIsLdap

int

[0, 1]

是否呼叫ldap会场

0:否

1:是

表3 SiteDetail

参数

类型

取值范围

参数说明

ucBaudRate

int

呼叫带宽

取值范围由WEB_RequestCallRateData返回

szAlias

string

可以为空,最大长度192个字符。

默认为空字符串即可

szIP

string

ip地址

默认为空字符串即可

szUri

string

号码

默认为空字符串即可

返回值

表4 点对点呼叫1返回值

参数

类型

取值范围

参数说明

success

int

[0, 1]

响应结果

0:失败

1:成功

data

Object

可选,空对象

成功返回数据。这里返回空。

例如:{"success":1,"data":""}

error

Object

可选

失败返回错误信息。详细参考表5

例如:{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

表5 error

参数

类型

取值范围

参数说明

id

int

32位整数

错误id,用于转换。

code

int

32位整数

错误码,跟错误id对应,具体含义参考错误码

param

Object

param 对象

失败响应的附带参数。

相关文档