会中状态设置

最近更新时间:2024-07-08 11:48:52

我的收藏

接口描述

描述:设置会议中的会议属性,例如:全体静音、是否允许参会者聊天设置、锁定会议、隐藏会议号和密码、是否开启等候室等,具体设置内容可以查询接口协议,目前暂不支持 MRA 设备作为被操作者的情况。企业 secret 鉴权用户可管理任何该企业用户创建的有效会议,OAuth 2.0鉴权用户只能管理通过 OAuth 2.0鉴权创建的有效会议。
说明:
1:操作者必须是会议的创建者、主持人或者联席主持人才可以设置。
2:调用该接口需要权限项 :MANAGE_MEETING 查看和管理您的会议。
请求方式:PUT
接口请求域名
https://api.meeting.qq.com/v1/real-control/meetings/{meetingId}/status


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

请求路径参数

参数名称
必选
参数类型
参数描述
meetingId
String
会议 ID,周期性会议传总会议 ID。

请求 body

参数名称
必选
参数类型
参数描述
operator_id
String
操作者 ID,支持会议创建者、主持人、联席主持人设置。
1:operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。
2:接口输入参数如果需要传用户 ID 时,operator_id 和 uuid 不可以同时为空,两个参数如果都传了以 operator_id 为准。
3:如果 operator_id_type=2,operator_id 必须和公共参数的 openid 一致。
operator_id_type
Integer
操作者 ID 的类型:
1:userid
2:openid
4:ms_open_id
uuid
String
操作者用户唯一身份 ID,仅支持创建者、主持人和联席主持人,且只适用于单场会议。即将废弃,推荐使用 ms_open_id。
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
mute_all
bool
是否全体静音:
true:全体静音
false:关闭全体静音
allow_unmute_by_self
bool
是否允许用户自己取消静音,请求参数 mute_all 必传,且 mute_all = true 时设置才生效。
true:允许
false:不允许
participant_join_mute
Integer
成员入会静音:
0:关闭静音
1:开启静音
2:超过6人自动开启静音
meeting_locked
bool
是否锁定会议:
true:锁定
false:关闭锁定
hide_meeting_code_password
bool
隐藏会议号和密码:
true:隐藏
false:不隐藏
allow_chat
Integer
允许参会者聊天设置:
0:允许参会者自由聊天
1:仅允许参会者公开聊天
2:仅允许私聊主持人
share_screen
bool
是否允许参会者发起屏幕共享:
true:允许
false:不允许
enable_red_envelope
bool
是否允许参会者发送红包:
true:允许
false:不允许
only_enterprise_user_allowed
bool
是否仅企业成员可入会:
true:仅企业成员可入会
false:不限制
play_ivr_on_join
bool
成员入会是否播放提示音:
true:成员入会播放提示音:
false:不播放
auto_waiting_room
bool
是否开启等候室:
true:开启
false:关闭

输出参数

成功返回空消息体,失败返回 错误码 和错误信息。

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
400
9042
无权限进行该操作,建议检查操作者身份或资源归属。
400
190455
非会议中不允许操作。
500
9002
非法请求。
500
190001
存在未注册的用户。
500
190456
查询用户不存在,请检查该用户是否注册。

示例

输入示例

PUT
https://api.meeting.qq.com//v1/real-control/meetings/1242152152161/status

{
"uuid": "afagsagwags",
"instanceid": 4,
"mute_all":true,
"allow_unmute_by_self":true,
"participant_join_mute":1,
"meeting_locked":true,
"hide_meeting_code_password":true,
"allow_chat":1,
"share_screen":true,
"enable_red_envelope":true,
"only_enterprise_user_allowed":true,
"play_ivr_on_join":true,
"auto_waiting_room":true
}