接口描述
描述:
会议创建者、主持人、联席主持人可以查询等候室成员列表,包括等候室内所有用户的进出记录。会前、会中、会后都可以查询。
“查询等候室成员列表”改为“获取实时等候室成员列表”,只有当前等候室的成员。
如果是 PMI 会议,返回的是 PMI 的 meeting_code。
需要分页,每页最大50条。
请求方式:GET
鉴权方式:JWT 鉴权、OAuth 鉴权。
OAuth 鉴权的权限为:查询会议、查询和管理会议。
接口请求域名:
https://api.meeting.qq.com/v1/meeting/{meeting_id}/waiting-room
输入参数
参数名称 | 是否必须 | 参数描述 |
operator_id | 是 | 操作者 ID。会议创建者、主持人、联席主持人可以调用该接口。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | 操作者 ID 的类型: 1:企业内用户 userid |
page | 是 | 当前页,页码起始值为1。 |
page_size | 是 | 每页数据条数。默认值20,最大值50。 |
输出参数
参数名称 | 参数类型 | 是否必须 | 参数描述 |
meeting_id | String | 是 | 会议的唯一 ID。 |
subject | String | 是 | 会议主题。 |
meeting_code | String | 是 | 会议 CODE。 |
schedule_start_time | Integer | 是 | 预定开始时间(单位:毫秒)。 |
schedule_end_time | Integer | 是 | 预定结束时间(单位:毫秒)。 |
participants | Participant 对象数组 | 是 | 人员对象数组。 |
current_size | Number | 是 | 当前页数据条数。 |
total_count | Number | 是 | 总数据条数。 |
current_page | Number | 是 | 当前页码。 |
total_page | Number | 是 | 总页数。 |
Participant 对象
参数名称 | 参数类型 | 是否必须 | 参数描述 |
user_name | String | 是 | 入会用户名(base64)。 |
userid | String | 是 | 成员用户 ID。 |
open_id | String | 是 | OAuth2.0 鉴权用户的 ID。 |
ms_open_id | String | 是 | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
instanceid | String | 是 | 用户的终端设备类型: 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 |
join_time | Integer | 是 | 加入时间(单位:毫秒)。 |
left_time | Integer | 是 | 离开时间(单位:毫秒)。 |
app_version | String | 是 | 应用版本。 |
customer_data | String | 否 | 如果参会成员是通过专属链接进会,给出用户专属字段 。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 9042 | 无权限操作。 |
500 | 9003 | 会议信息不存在。 |
500 | 190001 | 存在未注册的用户。 |
示例
输入示例
{"operator_id":"songe","operator_id_type":2,"page":5,"page_size":10}
输出示例
{"meeting_id": "1111111111111","subject": "consequat","meeting_code": "999999999","schedule_start_time": "dolo","schedule_end_time": "nulla qui veniam","participants": [{"user_name": "consectetur aliqua dolor amet","userid": "songe","open_id": "amet ad","ms_open_id": "enim proident v","instanceid": "1","join_time": "111111111","left_time": "111111111","app_version": "cillum eiusmod"}],"current_size": 30,"total_count": 1000,"current_page": 10,"total_page": 20}