接口描述
描述:会议中查询指定 MRA 设备的当前状态信息, 包括:
名称。
静音状态。
视频状态。
举手状态。
默认布局等。
请求方式:GET
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/query-participant
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID,周期性会议传总会议 ID。 |
operator_id | 是 | String | 操作者 ID。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid 4:ms_open_id |
instanceid | 是 | Integer | 设备类型 ID。 |
user_ms_open_id | 是 | String | 被查询用户临时身份 ID,该字段需 UrlEncode。 |
user_instance_id | 是 | Integer | 被查询用户设备类型 ID。 |
输出参数
返回查询用户的当前状态信息。
参数名称 | 参数类型 | 参数描述 |
ms_open_id | String | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
instanceid | Integer | 用户的终端设备类型 ID。 |
user_role | Integer | 用户角色: 0:普通成员角色 1:创建者角色 2:主持人 3:创建者+主持人 4:游客 5:游客+主持人 6:联席主持人 7:创建者+联席主持人 |
webinar_member_role | Integer | 网络研讨会成员角色: 0:普通参会角色 1:内部嘉宾 2:外部嘉宾 3:邀请链接入会嘉宾 4:观众 |
ip | String | 用户的 IP 地址。当用户在会中时才能返回。 |
name | String | 用户当前显示名称。 |
audio_state | Bool | 麦克风状态: true:开启 false:关闭 |
video_state | Bool | 摄像头状态: true:开启 false:关闭 |
screen_shared_state | Bool | 屏幕共享状态: true:开启 false:关闭 |
default_layout | Integer | 当前成员的默认分屏设置: 1:等分模式 2:全屏模式 3:1+N 说明:该参数仅支持 MRA 设备。 |
raise_hands_state | Bool | 举手状态: true:举手中 false:手放下 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190455 | 非会议中不允许操作。 |
500 | 190001 | 存在未注册的用户。 |
500 | 20010 | 查询 mra 状态信息失败。 |
500 | 202007 | 成员不在会中。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/meetings/100001/query-participant?operator_id=user1&operator_id_type=1&instanceid=1&user_ms_open_id=12345678&user_instance_id=9
输出示例
{"ms_open_id":"","instanceid":9,"user_role":0,"ip":"192.168.2.2","name":"user2","audio_state":true,"video_state":false,"screen_shared_state":false,"default_layout":1,"raise_hands_state":false}