查询参会人明细
查询参会人明细,具体权限要求请参考资源介绍
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/vc/v1/participant_list |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | vc:room:readonly 获取视频会议室信息 vc:rooms.room.detailinfo:read 获取视频会议明细信息 > Tip: 上方为历史权限,已无法继续申请。 > 新权限只支持使用user_access_token |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
meeting_start_time | string | 是 | 会议开始时间(unix时间,单位sec) 示例值:1655276858 |
meeting_end_time | string | 是 | 会议结束时间(unix时间,单位sec,若是进行中会议可填当前时间,否则填准确的会议结束时间) 示例值:1655276858 |
meeting_status | int | 否 | 会议状态(不传默认为已结束会议) 示例值:2 可选值有: - 1: 进行中 - 2: 已结束 - 3: 待召开 |
meeting_no | string | 是 | 9位会议号 示例值:123456789 |
user_id | string | 否 | 按参会飞书用户筛选(最多一个筛选条件) 示例值:ou_3ec3f6a28a0d08c45d895276e8e5e19b |
room_id | string | 否 | 按参会Rooms筛选(最多一个筛选条件) 示例值:omm_eada1d61a550955240c28757e7dec3af |
page_size | int | 否 | 分页尺寸大小 示例值:20 默认值: 20数据校验规则: - 取值范围: 20 ~ 100 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:20 |
webinar_user_role | string | 否 | 查询网络研讨会时的观众类型,"0"为嘉宾,"3"为观众 示例值:0 |
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ participants | participant\[\] | 参会人列表 |
└ participant_name | string | 参会者 |
└ department | string | 部门 |
└ user_id | string | 用户ID |
└ meeting_room_id | string | 会议室ID |
└ employee_id | string | 工号 |
└ phone | string | 电话 |
└ email | string | 邮箱 |
└ device | string | 设备 |
└ app_version | string | 客户端版本 |
└ public_ip | string | 公网IP |
└ internal_ip | string | 内网IP |
└ use_rtc_proxy | boolean | 代理服务 |
└ location | string | 位置 |
└ network_type | string | 网络类型 |
└ protocol | string | 连接类型 |
└ microphone | string | 麦克风 |
└ speaker | string | 扬声器 |
└ camera | string | 摄像头 |
└ audio | boolean | 音频 |
└ video | boolean | 视频 |
└ sharing | boolean | 共享 |
└ join_time | string | 入会时间,格式见响应体示例 |
└ leave_time | string | 离会时间,格式见响应体示例 |
└ time_in_meeting | string | 参会时长(秒),格式见响应体示例 |
└ leave_reason | string | 离会原因 |
└ accept_status | int | 日程响应状态 可选值有: - 1: 接受 - 2: 拒绝 - 3: 待确认 - 4: 未响应 |
└ is_external | boolean | 是否为外部参会人 |
└ webinar_user_role | string | 网络研讨会中的角色,"0"为嘉宾,"3"为观众 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"participants": [
{
"participant_name": "kehan",
"department": "development",
"user_id": "8efq90",
"meeting_room_id": "omm_8efq90",
"employee_id": "202205789",
"phone": "021-883889",
"email": "xxxx@163.com",
"device": "windows",
"app_version": "5.26.0-alpha.38",
"public_ip": "27.xx.xx.183",
"internal_ip": "192.xx.xx.13",
"use_rtc_proxy": false,
"location": "东莞",
"network_type": "wifi",
"protocol": "udp",
"microphone": "麦克风阵列 (Realtek(R) Audio)",
"speaker": "扬声器 (Realtek(R) Audio)",
"camera": "HD Camera",
"audio": true,
"video": true,
"sharing": false,
"join_time": "2022.12.23 11:16:59 (GMT+08:00)",
"leave_time": "2022.12.23 11:18:51 (GMT+08:00)",
"time_in_meeting": "00:01:52",
"leave_reason": "主持人结束会议",
"accept_status": 1,
"is_external": false,
"webinar_user_role": "0"
}
],
"page_token": "20",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 121001 | internal error | 服务器内部错误,如果重试无效可联系技术支持(邮箱:support@feishu.com) |
| 400 | 121002 | not support | 暂不支持该功能 |
| 400 | 121003 | param error | 参数错误,检查参数的取值范围(请按照上面字段说明自查) |
| 400 | 126003 | meeting number invalid (cannot smaller than 0) | 无效的会议号(不能小于0) |
| 400 | 126004 | meeting number length not correct (supposed to be 9) | 会议号应该是9位 |
| 400 | 126005 | start time error (cannot larger than now or smaller than 0) | 开始时间不能大于当前时间或者小于0 |
| 400 | 126006 | end time cannot exceed start time for one day or smaller than start time | 结束时间不能超过开始时间一天或者小于开始时间 |
| 400 | 126007 | userID and roomID cannot be set concurrently | 用户ID和roomID不能同时设置 |
| 400 | 126009 | cannot find meeting according to the params you provide | 根据提供的参数无法获取会议信息 |
| 400 | 126015 | not support room_id | 不支持用room_id筛选 |
| 404 | 121004 | data not exist | 请求的数据不存在 |
| 403 | 121005 | no permission | 无权限进行该操作,建议检查token类型、操作者身份以及资源的归属 |
