查询会议信息(包含会场列表)
接口名称
WEB_InitSiteListDataAPI
功能描述
查询会议信息(包含会场列表)。
应用场景
会场列表中包含入会和未入会会场。多用在窗口或界面初始化时。大部分会议控制操作是针对会场的,即需要下发会场参数。如观看会场等,此类操作的前提是获取到当前的会场列表。
URL
https://ip/action.cgi?ActionID=WEB_InitSiteListDataAPI
参数
无
返回值
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
success | int | [0, 1] | 响应结果 0:失败 1:成功 |
data | Object | 可选 | 成功返回数据。详细参考表2 data。 例如: {"success":1, "data":" { \"joinSum\":2, \"unJoinSum\":0, \"confState\":\"freetalk\", \"localMT\":{\"M\":1,\"T\":1}, \"isChair\":1, \"seeingSite\":{\"M\":1,\"T\":2}, \"hasChair\":1, \"permitChair\":1, \"chairMT\":{\"M\":1,\"T\":1}, \"auxTokenMT\":{}, \"isSiteCall\":0, \"isSupportRecord\":0, \"recStatus\":0, \"confLockState\":0, \"brdSite\":{\"M\":0,\"T\":0}, \"mulPicMode\":33, \"mutiPicCount\":0, \"mutiPicStyle\":0, \"mulPicCount\":255, \"autoViewIntvl\":0, \"autoBrdIntvl\":0, \"confLeftTime\":110, \"isInMinimcuConf\":0, \"viewMultipicID\":0, \"viewMultipicM\":0, \"brdID\":0, \"siteList\":[…], \"siteInfo\":[], \"voiceState\":0, \"voiceType\":\"site\", \"isAutoView\":0, \"auxCapb\":1, \"auxStatus\":\"idle\", \"auxMT\":{\"M\":0,\"T\":0}, \"isSupportT140\":0, \"isOpenT140\":1, \"isUnderMCU\":0, \"isPstnJoinConf\":0, \"isReportMode\":0, \"isCanReportMode\":0, \"isDeprivationAux\":0, \"ConfCtrlVersion\":3, \"teleConfState\":0 }" } |
error | Object | 可选 | 失败返回错误信息。详细参考表5。 例如:{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}} |
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
joinSum | int | [0, 400] | 入会会场数目 |
unJoinSum | int | [0, 400] | 未入会数目 |
confState | String | 最长20字节 | 会议状态 "autoView":循环观看 "freeTalk":自由讨论 "broadcast":广播 "rollCall":点名 |
localMT | Object | localMT 对象 | 本端MT号。 详细参考表3。 |
isChair | int | [0, 1] | 本端是否主席 0:否 1:是 |
seeingSite | Object | seeingSite 对象 | 本端正在观看的会场。详细参考表3。 |
hasChair | int | [0, 1] | 会议中是否存在主席 0:否 1:是 |
permitChair | int | [0, 1] | 会议中是否允许主席 0:否 1:是 |
chairMT | Object | chairMT 对象 | 主席会场的MT号 |
auxTokenMT | Object | auxTokenMT 对象 | 辅流令牌所有者MT号 |
isSiteCall | int | [0, 1] | 本端是否是主叫呼集方 0:否 1:是 |
isSupportRecord | int | [0, 1] | 是否支持录播 0:否 1:是 |
recStatus | int | [0, 1] | 录播状态 1:正在录播 0:停止录播 |
confLockState | int | [0, 1] | MiniMCU会议锁定状态 0:没有锁定 1:锁定 |
brdSite | Object | brdSite 对象 | 正在被广播的会场MT号。详细参考表3。 |
mulPicMode | int | [0, 255] | 多画面模式 |
mutiPicCount | int | [0, 255] | 子画面个数 |
mutiPicStyle | int | [0, 255] | 多画面样式 |
mulPicCount | int | [0, 255] | 多画面组数,跟R11的多组多画面特性无关,智真API不需关注。 |
autoViewIntvl | int | [0, 65535] | 循环观看间隔,单位分钟。 |
autoBrdIntvl | int | [0, 65535] | 循环广播间隔,单位分钟。 |
confLeftTime | int | [0, 65535] | 会议剩余时间,单位分钟。 |
isShowLeftTime | int | [0, 1] | 是否显示会议剩余时间 0:否 1:是 |
isInMinimcuConf | int | [0, 1] | 是否加入MiniMCU会议, 本地多点和终端加入MiniMCU会议后都置1。 0:否 1:是 |
viewMultipicID | int | [0, 255] | 观看的多组多画面的ID |
viewMultipicM | int | [0, 255] | 观看的多组多画面的M号 |
brdID | int | 32位整数 | 正在被广播的多组多画面ID |
siteList | Array | siteList 对象 | 会场列表。详细参考表4。 |
siteInfo | Object | 空对象 | - |
voiceState | int | [0, 1] | 声控切换状态 0:禁用 1:启用 |
voiceType | string | {"site","screen"} | 声控切换类型 "site":按照会场 "screen":按照屏 |
isAutoView | int | [0, 1] | 循环观看状态 0:禁用 1:启用 |
auxCapb | int | [0, 2] | 辅流能力 0: 否 1: Presentation 2: LIVE |
auxStatus | int | {"idle","local","remote"} | 辅流状态 idle:空闲 local:本地持有令牌 remote:远端持有令牌 |
auxMT | Object | auxMT对象 | 发送辅流会场MT号,详细参考表3。 |
isSupportT140 | int | [0, 1] | 是否支持T140 0:不支持 1:支持 |
isOpenT140 | int | [0, 1] | 是否启用T140 0:不启用 1:启用 |
isUnderMCU | int | [0, 1] | 是否在大MCU下召集会议 0:否 1:是 |
isPstnJoinConf | int | [0, 1] | PSTN是否加入会议,智真使用,终端无需关注。 0:否 1:是 |
isReportMode | int | [0, 1] | 是否汇报模式 0:禁用 1:启用 |
isCanReportMode | int | [0, 1] | 是否支持汇报模式 0:不支持 1:支持 |
isDeprivationAux | int | [0, 1] | 剥夺辅流令牌 0:否 1:是 |
ConfCtrlVersion | int | [0, 3] | 会控版本号 |
teleConfState | int | [0, 10] | 智真会控状态 0:自动多画面 1:广播会场 2:广播多画面 3:点名发言 4:声控切换 5:自动广播 6:取消广播 7:自由观看 8:自动浏览 9:每端口多画面 |
nonChairCtrlList | Array | 整型数组 | 支持的非主席会控功能 |
auditSiteDir | int | [0, 1] | 旁听会场方向 |
LockAuxMT | Object | LockAuxMT对象 | 锁定辅流的会场MT号,详细参考表3。 |
auxLocakState | int | [0, 1] | 辅流锁定状态 |
siteCallType | int | {3, 8} | 主叫呼集类型 3:H.323 8:SIP |
dataConf | int | [0, 1] | 是否数据会议 0:否 1:是 |
isSupportAuxLock | int | [0, 1] | 是否支持辅流锁定 0:不支持 1:支持 |
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
siteNum | int | 32位整数 | 会场句柄 |
joinConf | int | [0, 1] | 是否入会 0:否 1:是 |
M | int | [0, 400] | M号 |
T | int | [0, 400] | T号 |
type | string | 非空,最大16个字符 | 会场类型("E1"/"H.323"/"sip"/"H.323 Phone"/"4E1"等) |
isPSTN | int | [0, 1] | 是否语音会场 0:否 1:是 |
isGetName | int | [0, 1] | 是否获取到会场名 0:否 1:是 |
siteName | string | 非空,最大64个字符 | 会场名 |
isGetNumber | int | [0, 1] | 是否获取到会场号码 0:否 1:是 |
siteNumber | string | 非空,最大64个字符 | 会场号码 |
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, 400] | 循环观看次序 |
autoBroadSeq | int | [0, 400] | 循环广播次序 |
isChair | int | [0, 1] | 是否主席 0:否 1:是 |
class | int | [0,65535] | 会场分组字段, 前台使用, 后台不填充。 |
MT | string | 非空,最大32个字符 | 检索标识,M-T方式拼接成的字符串。 |
isView | int | [0, 1] | 是否本端被观看,前台处理,后台不填充。 0:否 1:是 |
isBroad | int | [0, 1] | 是否本端被广播,前台处理,后台不填充。 0:否 1:是 |
siteType | String | [0, 10] | 普通会场"site",智真会场"tp",该字段是智真专用。 |
screenNum | int | [0, 65535] | 智真专用字段 |
remotemicstates | int | [0, 1] | 是否远端被被闭音 0:否 1:是 |
reqTime | string | 可以为空,最长128个字符 | 格式化的时间请求 |
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
id | int | 32位整数 | 错误id,用于转换。 |
code | int | 32位整数 | 错误码,跟错误id对应,具体含义参考错误码。 |
param | Object | param 对象 | 失败响应的附带参数。 |

