获取实时等候室成员列表

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

我的收藏

接口描述

描述
会议拥有者获取某指定会议的等候室成员列表,需开启等候室且为“会议进行中”状态。
只有会议的拥有者即创建者可以查询等候室成员列表,其他用户的调用会被拒绝。如果会议非进行中,调用此接口查询会返回空列表。
企业 secret 鉴权用户(会议创建者)可获取任何该企业用户创建的会议中的等候室成员列表,OAuth 2.0鉴权用户(会议创建者)只能获取用户通过 OAuth 2.0鉴权创建的会议中的等候室成员列表。
此接口暂不支持 MRA 设备作为被操作者的情况。
请求方式:GET
接口请求域名
https://api.meeting.qq.com/v1/meetings/{meeting_id}/waiting-room-participants?userid={userId}


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meeting_id
String
会议的唯一 ID,周期性会议传总会议 ID。
userid
String
会议创建者的用户 ID(企业内部请使用企业唯一用户标识;OAuth 2.0鉴权用户请使用 openId)。
page_size
int
分页大小,默认10,最大50。
page
int
页码,从1开始。

输出参数

参数名称
参数类型
参数描述
total_count
int
分页查询返回数据总数。
current_size
int
分页查询返回单页数据条数。
current_page
int
分页查询返回当前页码。
total_page
int
分页查询返回分页总数。
meeting_id
String
会议唯一 ID。
meeting_code
String
会议 CODE。
subject
String
会议主题 (base 64编码)。
schedule_start_time
int
预定的会议开始时间戳(单位秒)。
schedule_end_time
int
预定的会议结束时间戳(单位秒)。
participants
Participant 对象数组
等候室人员对象数组。

Participant 对象

参数名称
参数类型
参数描述
userid
String
等候室成员用户 ID。
uuid
String
用户唯一身份 ID,单场会议唯一。
user_name
String
入会用户名(base 64)。
instanceid
Integer
用户的终端设备类型:
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 Mac
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch Iphone
app_version
String
客户端版本。
open_id
String
等候室 OAuth 2.0鉴权用户的 ID。
ms_open_id
String
成员会中唯一 ID。
customer_data
String
如果参会成员是通过专属链接进会,给出用户专属字段 。

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
400
190301
请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。
500
9003
MEETING NOT EXIST。
400
9042
无权限进行该操作,建议检查操作者身份或资源归属。
500
190001
存在未注册的用户。

示例

输入示例

GET https://api.meeting.qq.com/v1/meetings/144115214488302892/waiting-room-participants?userid=owner1&page_size=20

输出示例

{
"total_count":2,
"current_size":1,
"current_page":1,
"total_page":1,
"meeting_id":"144115214488302892",
"meeting_code":"746950080",
"subject":"asfagaqga=",
"schedule_start_time":1572085800,
"schedule_end_time":1572089400,
"participants":[
{
"userid":"test1",
"user_name":"dBVzdDE=",
"uuid":"asfsasagsasgqgqhkkk",
"app_version":"1.12.321",
"instanceid":1
"open_id":"xxxxxxx123xxxxxx",
"ms_open_id":"enim proident v"
},
{
"userid":"test2",
"user_name":"dGvzdDI=",
"uuid":"193jskao1j9sla12k",
"app_version":"1.12.321",
"instanceid":1,
"customer_data":"test",
"open_id":"xxxxxxx123xxxxxx",
"ms_open_id":"enim proident k"
}
]
}