接口名称
9: SIP PHONE
3.1.5 会议控制类
3.1.5.1 查询会议信息(包含会场列表)
接口名称
WEB_InitSiteListDataAPI
功能描述
查询会议信息(包含会场列表)。
应用场景
会场列表中包含入会和未入会会场。多用在窗口或界面初始化时。大部分会议控制操 作是针对会场的,即需要下发会场参数。如观看会场等,此类操作的前提是获取到当 前的会场列表。
URL
https://ip/action.cgi?ActionID=WEB_InitSiteListDataAPI
参数
无
返回值
表3-204 查询会议信息返回值
参数 类
型
取值范围 参数说明
success int [0, 1] 响应结果 0:失败 1:成功
参数 类 型
取值范围 参数说明
data Obj
ect 可选 成功返回数据。详细参考表2 data。
参数 类
error Obj
ect 可选 失败返回错误信息。详细参考表3-208。 unJoinSum int [0, 400] 未入会数目 confState Stri
ng 最长20字节 会议状态
"autoView":循环观看
"freeTalk":自由讨论
"broadcast":广播
"rollCall":点名 localMT Obj
ect localMT 对
象 本端MT号。 详细参考表3-206。
isChair int [0, 1] 本端是否主席
0:否 1:是 seeingSite Obj
ect seeingSite
对象 本端正在观看的会场。详细参考表3-206。
参数 类
permitChair int [0, 1] 会议中是否允许主席 0:否
1:是 chairMT Obj
ect chairMT 对
象 主席会场的MT号
auxTokenM
T Obj
ect auxTokenM
T 对象 辅流令牌所有者MT号
isSiteCall int [0, 1] 本端是否是主叫呼集方 0:否 brdSite Obj
ect brdSite 对象 正在被广播的会场MT号。详细参考表3-206。
mulPicMode int [0, 255] 多画面模式 mutiPicCoun
t int [0, 255] 子画面个数
mutiPicStyle int [0, 255] 多画面样式
mulPicCount int [0, 255] 多画面组数,跟R11的多组多画面特性无关,
智真API不需关注。
autoViewInt
vl int [0, 65535] 循环观看间隔,单位分钟。
autoBrdIntvl int [0, 65535] 循环广播间隔,单位分钟。
confLeftTim
e int [0, 65535] 会议剩余时间,单位分钟。
参数 类
brdID int 32位整数 正在被广播的多组多画面ID
siteList Arr
ay siteList 对象 会场列表。详细参考表3-207。
siteInfo Obj
ect 空对象
-voiceState int [0, 1] 声控切换状态 0:禁用 1:启用 voiceType stri
ng {"site","scre
en"} 声控切换类型
"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 Obj auxMT对象 发送辅流会场MT号,详细参考表3-206。
参数 类 isOpenT140 int [0, 1] 是否启用T140
0:不启用 1:启用
isUnderMCU int [0, 1] 是否在大MCU下召集会议 0:否
参数 类 型
取值范围 参数说明
nonChairCtrl
List Arr
ay 整型数组 支持的非主席会控功能
auditSiteDir int [0, 1] 旁听会场方向 LockAuxMT Obj
ect LockAuxMT
对象 锁定辅流的会场MT号,详细参考表3-206。
auxLocakSta
te int [0, 1] 辅流锁定状态
siteCallType int {3, 8} 主叫呼集类型 3:H.323 8:SIP dataConf int [0, 1] 是否数据会议
0:否 1:是 isSupportAu
xLock int [0, 1] 是否支持辅流锁定
0:不支持 1:支持
表3-206 WEB_MT_STRU
参数 类
型
取值范围 参数说明
M int [0, 400] 会场M号
T int [0, 400] 会场T号
表3-207 WEB_SITE_LIST
参数 类
型
取值范围 参数说明
siteNum int 32位整数 会场句柄
joinConf int [0, 1] 是否入会 0:否 1:是
M int [0, 400] M号
参数 类 型
取值范围 参数说明
type stri
ng 非空,最大
16个字符 会场类型("E1"/"H.323"/"sip"/"H.323 Phone"/"4E1"等) siteName stri
ng 非空,最大 siteNumber stri
ng 非空,最大
isAutoView int [0, 1] 是否在循环观看队列 0:否
1:是
isAutoBroad int [0, 1] 是否在循环广播队列 0:否
参数 类
MT stri
ng 非空,最大 siteType Stri
ng [0, 10] 普通会场"site",智真会场"tp",该字段是智真 专用。
screenNum int [0, 65535] 智真专用字段 remotemicst
ates int [0, 1] 是否远端被被闭音
0:否 1:是 reqTime stri
ng 可以为空,
最长128个字 符
格式化的时间请求
表3-208 error
参数 类
param Obj
ect param 对象 失败响应的附带参数。