获取会议受邀成员列表

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

我的收藏

接口描述

描述:根据会议 ID 获取受邀成员列表,支持分页获取,且只有会议的创建者才有权限获取。
请求方式:GET
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/invitees?userid={userid}&instanceid={instanceid}&pos={pos}


输入参数

参数名称
必选
参数类型
参数描述
meeting_id
String
会议 ID。
userid
String
调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
企业唯一用户标识说明:
1:企业对接 SSO 时使用的员工唯一标识 ID。
2:企业调用创建用户接口时传递的 userid 参数。
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
pos
Integer
分页获取受邀成员列表的查询起始位置值。此参数为非必选参数,默认值为0,从头开始查询。输出参数“has_remaining”为 true,表示还存在受邀成员需要继续查询;输出参数“next_pos”即下一次查询的“pos”值。多次调用该接口直到输出参数“has_remaining”为 false。

输出参数

参数名称
参数类型
参数描述
invitees
User 对象数组
会议邀请的参会者。
has_remaining
Boolean
是否还存在受邀成员需要继续查询。
next_pos
Integer
当“has_remaining”为 true 时,下次查询时输入参数“pos”的值。

User 对象

参数名称
参数类型
参数描述
userid
String
用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
nick_name
String
用户昵称。

错误码列表

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

示例

输入示例

GET https://api.meeting.qq.com/v1/meetings/100001/invitees?userid=user1&instanceid=1&pos=0

输出示例

{
"invitees": [
{
"operator_id_type": 1,
"operator_id": "21",
"nick_name": "史磊",
"userid": "71"
},
{
"operator_id": "76",
"userid": "13",
"nick_name": "薛秀兰",
"operator_id_type": 1
},
{
"userid": "15",
"operator_id_type": 1,
"operator_id": "38",
"nick_name": "沈杰"
},
{
"operator_id_type": 1,
"userid": "32",
"operator_id": "71",
"nick_name": "卢杰"
},
{
"operator_id": "69",
"operator_id_type": 1,
"userid": "99",
"nick_name": "魏洋"
}
],
"has_remaining": false,
"next_pos": 66
}