查询会议基础信息
请求方法
GET
请求地址
/ctrl/meetings/{meetingNumber}/setting
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
meetingNumber |
Query |
String |
是 |
会议号 |
HTTP状态码
返回值 |
描述 |
200 |
操作成功 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
404 |
找不到请求的资源 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
meetingNumber |
String |
会议号 |
meetingId |
String |
会议Id |
mediaSetting |
mediaSetting |
媒体配置 |
lobbySetting |
lobbySetting |
大厅配置 |
ivrSetting |
ivrSetting |
提示音配置 |
chatSetting |
chatSetting |
会议中聊天配置 |
lock |
Boolean |
是否开启锁定会议 |
allowRenameSelf |
Boolean |
是否开启自己改名 |
showAvatar |
Boolean |
是否开启显示头像 |
参数 |
数据类型 |
描述 |
audio |
audio |
音频配置 |
video |
video |
视频配置 |
share |
share |
辅流配置 |
+ audio 对象定义
参数 |
数据类型 |
描述 |
muteOnJoin |
Boolean |
是否开启入会自动静音 |
allowUnmuteSelf |
Boolean |
是否开启解除静音需用户同意 |
speakingMode |
String |
发言权限,可选:free(自由发言)、handUp(申请发言)。 |
+ video 对象定义
参数 |
数据类型 |
描述 |
muteOnJoin |
Boolean |
是否开启入会自动静音 |
allowUnmuteSelf |
Boolean |
是否开启解除视频需用户同意 |
+ share 对象定义
参数 |
数据类型 |
描述 |
sharePermission |
String |
共享权限,可选: hostStart(仅主持人可共享)、multi(所有参会者可共享) |
annotationPermission |
String |
批注权限,可选:all(所有参会者可批注)、sharerHost(仅共享者和主持人可批注) |
watermark |
Boolean |
是否开启辅流水印 |
+ lobbySetting 对象定义
参数 |
数据类型 |
描述 |
enabled |
Boolean |
是否开启等候室 |
autoAdmitted |
Integer |
等候室配置,可选:0(仅主持人可绕过等候室)、1(企业内所有人可绕过等候室)、2(受邀参会者可绕过等候室)、3(企业内所有人及受邀参会者可绕过等候室) |
+ ivrSetting 对象定义
参数 |
数据类型 |
描述 |
chime |
String |
入会/离会提示音,可选:off(无提示音)、self(仅入会方接收提示)、all(所有成员接收提示)、 selfAndHost(仅入会方、主持人接收提示) |
+ chatSetting 对象定义
参数 |
数据类型 |
描述 |
attendeePermission |
String |
与会者聊天权限,可选:all(允许群里和私聊)、public(仅允许群聊)、host(仅允许私聊主持人)、disabled(全体成员禁言) |
audiencePermission |
String |
观众聊天权限,可选:public(仅允许群聊)、disabled(全体成员禁言) |
请求消息示例
GET /ctrl/meetings/819700180001/setting HTTP/1.1
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"meetingNumber": "819700180001",
"meetingId": "2110203078715010671918",
"mediaSetting": {
"audio": {
"muteOnJoin": false,
"allowUnmuteSelf": true,
"speakingMode": "free"
},
"video": {
"muteOnJoin": false,
"allowUnmuteSelf": true
},
"share": {
"sharePermission": "allGrab",
"annotationPermission": "all",
"watermark": false
}
},
"lobbySetting": {
"enabled": false,
"autoAdmitted": 2
},
"ivrSetting": {
"chime": "self"
},
"chatSetting": {
"attendeePermission": "all",
"audiencePermission": "disabled"
},
"lock": false,
"allowRenameSelf": true,
"showAvatar": false
}