查看会场信息
接口名称
WEB_QuerySiteInfoAPI
功能描述
通过M/T查看某个会场的具体信息。
应用场景
会议中,MT号的组合可以作为会场唯一的标识。添加会场或者未入会会场入会后,常调用该接口,查询新增会场的详细信息,并根据具体应用场景做处理。
URL
https://ip/action.cgi?ActionID=WEB_QuerySiteInfoAPI
参数
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
M |
int |
[0, 400] |
会场M号 |
T |
int |
[0, 400] |
会场T号 |
返回值
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
success |
int |
[0, 1] |
响应结果 0:失败 1:成功 |
data |
Object |
可选 |
成功返回数据。详细参考表3。 例如: {"success":1, "data":" {\"siteInfo\": {\"siteNum\":0, \"joinConf\":1, \"M\":1, \"T\":2, \"type\":\"H.323\", \"isPSTN\":0, \"isGetName\":1, \"siteName\":\"075564228\", \"isGetNumber\":0, \"siteNumber\":\"\", \"mute\":0, \"silent\":0, \"isReqTalk\":0, \"isAutoView\":0, \"isAutoBroad\":0, \"autoViewSeq\":0, \"autoBroadSeq\":0, \"isChair\":0, \"class\":0, \"MT\":\"1-2\", \"isView\":0, \"isBroad\":0, \"siteType\":\"site\", \"screenNum\":0, \"remotemicstates\":0 }, \"siteStatus\":{} }" } |
error |
Object |
可选 |
失败返回错误信息。详细参考表6。 例如:{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}} |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
siteInfo |
Object |
siteInfo 对象 |
会场信息,参考表4 |
siteStatus |
Object |
siteStatus 对象 |
会场状态,音视频协议等。参数结构参考表5 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
siteNum |
int |
[0, 255] |
会场句柄 |
joinConf |
int |
[0, 1] |
是否入会 0:否 1:是 |
M |
int |
[0, 400] |
M号 |
T |
int |
[0, 400] |
T号 |
type |
String |
最长20字节 |
会场类型("E1"/"H.323"/"sip"/"H.323 Phone"/"4E1"等) |
isPSTN |
int |
[0, 1] |
是否语音会场 0:否 1:是 |
isGetName |
int |
[0, 1] |
是否获取到会场名 0:否 1:是 |
siteName |
String |
最长192字节 |
会场名 |
isGetNumber |
int |
[0, 1] |
是否获取到会场号码 0:否 1:是 |
siteNumber |
String |
最长128字节 |
会场号码 |
mute |
int |
[0, 1] |
是否被闭音 0:否 1:是 |
silent |
int |
[0, 1] |
是否被静音 0:否 1:是 |
isReqTalk |
int |
[0, 1] |
是否请求发言 0:否 1:是 |
isAutoView |
int |
[0, 1] |
是否在循环观看队列 0:否 1:是 |
isAutoBroad |
int |
[0, 1] |
是否在循环广播队列 0:否 1:是 |
autoViewSeq |
int |
[0, 65535] |
循环观看次序 |
autoBroadSeq |
int |
[0, 65535] |
循环广播次序 |
isChair |
int |
[0, 1] |
是否主席 0:否 1:是 |
class |
int |
[0, 65535] |
会场分组字段, 前台使用, 后台不填充。 |
MT |
String |
最长10字节 |
检索标识,M-T方式拼接成的字符串。 |
isView |
int |
[0, 65535] |
是否本端被观看,前台处理,后台不填充。 |
isBroad |
int |
[0, 65535] |
是否本端被广播,前台处理,后台不填充。 |
siteType |
String |
最长10字节 |
普通会场"site",智真会场"tp",该字段是智真专用。 |
screenNum |
int |
[0, 65535] |
智真专用字段。 |
remotemicstates |
int |
[0, 1] |
是否远端被闭音 0:否 1:是 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
ucSiteNum |
int |
32整数 |
会场句柄 |
szVideoFormatSend |
String |
最长21字节 |
视频协议发送 |
szVideoFormatRev |
String |
最长21字节 |
视频协议接收 |
szVideoBandWidthSend |
String |
最长13字节 |
视频带宽发送 |
szVideoBandWidthRev |
String |
最长17字节 |
视频带宽接收 |
szAuxStreamFormatSend |
String |
最长21字节 |
辅流协议发送 |
szAuxStreamFormatRev |
String |
最长21字节 |
辅流协议接收 |
szAuxStreamBandWidthSend |
String |
最长13字节 |
辅流带宽发送 |
szAuxStreamBandWidthRev |
String |
最长17字节 |
辅流带宽接收 |
szAudioProtocolSend |
String |
最长21字节 |
音频协议发送 |
szAudioProtocolRev |
String |
最长21字节 |
音频协议接收 |
szAudioBandWidthSend |
String |
最长13字节 |
音频带宽发送 |
szAudioBandWidthRev |
String |
最长13字节 |
音频带宽接收 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
id |
int |
32位整数 |
错误id,用于转换。 |
code |
int |
32位整数 |
错误码,跟错误id对应,具体含义参考错误码。 |
param |
Object |
param 对象 |
失败响应的附带参数。 |