移出用户

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

我的收藏

接口描述

描述
将会议中用户移出会议,操作者必须是会议的创建者、主持人或者联席主持人才可以设置。
支持对云会议已入会成员和 Webinar 观众移出。
支持 MRA 设备和 PSTN 设备为被操作者时的移出用户操作。
企业 secret 鉴权用户可管理任何该企业该用户创建的有效会议,OAuth2.0 鉴权用户只能管理通过 OAuth2.0 鉴权创建的有效会议。
说明:
1:操作者必须是会议的创建者、主持人或者联席主持人才可以设置。
2:调用该接口需要权限项:MANAGE_MEETING 查看和管理您的会议。
请求方式:PUT
接口请求域名
https://api.meeting.qq.com/v1/real-control/meetings/{meeting_id}/kickout


输入参数

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

请求路径参数

参数名称
必选
参数类型
参数描述
meeting_id
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,仅支持创建者、主持人和联席主持人,且只适用于单场会议。即将废弃,推荐使用 operator_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
allow_rejoin
bool
移出后是否允许再次入会:
true:允许再次入会
false:不允许
reason
String
移出原因说明。当用户设备为 MRA 时,该参数必须填写移出原因。
users
User 对象数组
被操作用户对象信息列表。单次最多处理20个对象。

User 对象

参数名称
必选
参数类型
参数描述
to_operator_id
String
被操作者 ID,根据 to_operator_id_type 的值,使用不同的类型。
to_operator_id_type
Integer
被操作者 ID 的类型:
4:ms_open_id
uuid
String
被操作者用户唯一身份 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
说明:请与被操作者的设备类型保持一致,否则不生效。

输出参数

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

错误码列表

状态码
错误码
错误描述
500
9002
非法请求。
500
190001
存在未注册的用户。
400
202007
成员不在会中。
400
9042
无权限进行该操作,建议检查操作者身份或资源归属。
500
100000
获取相关信息失败。
500
10
参数错误,具体字段错误原因,详细见 message 字段。
400
190455
非会议中不允许操作。
500
190456
查询用户不存在,请检查该用户是否注册。
400
190004
参数非法,请对照接口文档检查您的参数。

示例

输入示例

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

{
"uuid": "afagsagwags",
"instanceid": 4,
"allow_rejoin":false,
"reason":"test",
"users":[{
"uuid":"agaqwwgdkkddd",
"instanceid":2
},
{
"uuid":"agaqwwgdkksd",
"instanceid":5
}
]
}