召集会议
接口名称
WEB_ScheduleConfAPI
功能描述
从终端召集会议时,调用该接口。召集会议响应消息是MSG_SITECALL_RSP。
应用场景
从终端发起召集会议。呼叫时选择的线路类型和带宽必须满足WEB_RequestCallTypeDataAPI和WEB_RequestCallRateDataAPI返回的结果。
URL
https://ip/action.cgi?ActionID=WEB_ScheduleConfAPI
参数
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
uwID |
int |
32位整数 |
会议ID,0 表示未定义的记录。 |
szName |
String |
最长192字节 |
会议名称 |
ucConfMode |
int |
{1} |
自定义会议始终填1 |
stStartTime |
Object |
stStartTime 对象 |
会议召开时间。详细参考表2。 |
ucCallType |
int |
[0, 255] |
固定填254 |
uwBaudRate |
int |
[0, 65535] |
速率 |
bSupportMultiStream |
int |
[0, 255] |
固定填254 |
ucAuxStrmRoleLabel |
int |
[0, 255] |
固定填254 |
ucMutiPicGroupNum |
int |
[0, 255] |
多画面组数,固定填0。 |
ucSubPicNum |
int |
[0, 255] |
总子画面数,固定填0。 |
ucMutiPicMode |
int |
[0, 255] |
多画面模式,固定填0。 |
ucSrtpEncrypt |
int |
[1,2] |
SRTP 加密方式 1:强制加密 2:自动加密 |
bMiniMcuCallset |
int |
[0, 1] |
是否使用MiniMCU开会,始终填0。 |
stMcuCallsetInfo |
Object |
stMcuCallsetInfo 对象 |
大MCU呼集使用的参数字段。参考表3。 |
stMiniMcuCallsetInfo |
Object |
stMiniMcuCallsetInfo 对象 |
当前不支持MiniMCU,固定为空。 |
uwTotalSiteCount |
int |
[0, 65535] |
总会场个数 |
auwSiteID |
整型数组 |
auwSiteID 对象 |
会场ID列表 |
auwGroupID |
整型数组 |
auwGroupID 对象 |
群组ID列表 |
astTempSiteInfo |
Object |
astTempSiteInfo 对象 |
临时会场。参考表4。 |
ulUseFre |
int |
32位整数 |
使用频率 |
ucIsDirectBroadcast |
int |
[0, 1] |
是否支持直播,固定填0。 |
ucIsRecordPlay |
int |
[0, 1] |
是否支持录播,固定填0。 |
ulSetReportMode |
int |
[0, 1] |
汇报模式 0: 一般模式 1: 汇报模式 |
ucIsAutoApplyChair |
int |
[0,1] |
是否召集是自动申请主席 0:否 1: 是 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
year |
int |
正整数且大于等于当前年份 |
年 |
month |
uint8 |
[1, 12] |
月 |
day |
uint8 |
[1, 31] |
日 |
hour |
uint8 |
[0, 23] |
时 |
minute |
uint8 |
[0, 59] |
分 |
second |
uint8 |
[0, 59] |
秒 |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
ucPreType |
int |
[0, 1] |
预约类型 0:呼集 1:预约(暂不支持) |
stPreTime |
Object |
stPreTime 对象 |
预约会议召开时间。参考表2。 |
uwDuration |
int |
[0, 360] |
预约会议专用。表示会议持续时间,单位分钟。 |
ucMultiPic |
int |
{0, 2, 3, 4, 6, 8, 9, 13, 16} |
多画面模式,对应的多画面个数。 |
ucH235Policy |
int |
[1, 2] |
H.235加密方式 1:强制加密 2:自动加密 |
bDataConf |
int |
[0, 1] |
是否数据会议 0:非数据会议 1:数据会议 |
ucMLPRate |
int |
32位整数 |
MLP速率,固定填0。 |
uwIPAnonymousSiteNum |
int |
[0, 255] |
H.323匿名会场数 |
uwISDNAnonymousSiteNum |
int |
32位整数 |
ISDN匿名会场数 |
uwPSTNAnonymousSiteNum |
int |
32位整数 |
PSTN匿名会场数 |
uwSIPAnonymousSiteNum |
int |
[0, 29] |
SIP匿名会场数 |
szConfCtrlPassword |
String |
可以为空 |
会控密码 |
szCardNo |
String |
可以为空 |
呼集验证时的卡号 |
szPassword |
String |
可以为空 |
呼集验证时的密码 |
ucPaySide |
int |
[0, 1] |
付费方 0:其它帐号付费 1: 本端付费 |
ucVideoEncode |
int |
32位整数 |
主流协议,固定254。 |
ucVideoFormat |
int |
32位整数 |
主流格式,固定254。 |
ucVideoFrame |
int |
32位整数 |
主流帧率,固定254。 |
ucAudioEncode |
int |
32位整数 |
音频协议,固定254。 |
ucDuleAudioChn |
int |
32位整数 |
音频声道,固定254。 |
ucLSDRate |
int |
32位整数 |
LSD速率,固定0。 |
ucAuxStreamProtocol |
int |
32位整数 |
辅流协议,固定254。 |
uwAuxStreamBandWidth |
int |
32位整数 |
辅流带宽,固定0。 |
ucAuxStreamFormat |
int |
32位整数 |
辅流格式,固定254。 |
ucAuxStreamFrame |
int |
32位整数 |
辅流帧率,固定254。 |
ucIsUseVoiceSwitch |
int |
[0, 1] |
是否使用声控切换 0:不使用 1:使用 |
ucVoiceSwitchType |
int |
[0, 1] |
声控切换类型 0:按会场声控切换 1:按屏声控切换 |
ucVoiceSwitchLimit |
int |
[1, 100] |
声控切换门限值 |
返回值
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
success |
int |
[0, 1] |
响应结果 0:失败 1:成功 |
data |
Object |
空对象,可选 |
成功返回数据。这里返回空。 例如:{"success":1,"data":""} |
error |
Object |
可选 |
失败返回错误信息。详细参考表6。 例如:{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}} |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
id |
int |
32位整数 |
错误id,用于转换。 |
code |
int |
32位整数 |
错误码,跟错误id对应,具体含义参考错误码。 |
param |
Object |
param 对象 |
失败响应的附带参数。 |