查询会议明细
查询会议明细,具体权限要求请参考资源介绍
Tip: 说明
本接口适用于查询 进行中 或者 已结束 的会议明细。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/vc/v1/meeting_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 |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 是 | 查询开始时间(unix时间,单位sec) 示例值:1655276858 |
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 |
meeting_type | int | 否 | 按会议类型筛选(最多一个筛选条件,如果设置多个,参数校验会失败) 示例值:2 可选值有: - 1: 全部类型(默认) - 2: 视频会议 - 3: 本地投屏 |
page_size | int | 否 | 分页尺寸大小 示例值:20 默认值: 20数据校验规则: - 取值范围: 20 ~ 100 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:20 |
include_external_meetings | boolean | 否 | 是否查询外部会议(不传默认为不查询) 示例值:false |
include_webinar | boolean | 否 | 是否查询网络研讨会(不传默认为不查询) 示例值:false |
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 | \- | - |
└ meeting_list | meeting_info\[\] | 会议列表 |
└ meeting_id | string | 9位会议号 |
└ meeting_topic | string | 会议主题 |
└ meeting_type | int | 会议类型 可选值有: - 1: 全部类型(默认) - 2: 视频会议 - 3: 本地投屏 |
└ organizer | string | 组织者 |
└ department | string | 部门 |
└ user_id | string | 用户ID |
└ employee_id | string | 工号 |
└ email | string | 邮箱 |
└ mobile | string | 手机 |
└ meeting_start_time | string | 会议开始时间,格式见响应体示例 |
└ meeting_end_time | string | 会议结束时间,格式见响应体示例 |
└ meeting_duration | string | 会议持续时间(秒),格式见响应体示例 |
└ number_of_participants | string | 参会人数 |
└ number_of_devices | string | 累计入会设备数 |
└ audio | boolean | 音频 |
└ video | boolean | 视频 |
└ sharing | boolean | 共享 |
└ recording | boolean | 录制 |
└ telephone | boolean | 电话 |
└ reserved_rooms | reserved_room\[\] | 关联会议室列表,只有待召开的会议支持该字段。 |
└ room_id | string | 会议室ID |
└ room_name | string | 会议室名称 |
└ has_related_document | boolean | 是否有关联文档和纪要 |
└ ai_note | boolean | 是否使用AI纪要 |
└ is_external | boolean | 是否为外部会议 |
└ meeting_subtype | int | 会议子类型 可选值有: - 0: 全部类型(默认) - 1: 投屏 - 2: 有线投屏 - 3: 妙享 - 4: 聊天室 - 5: 飞阅会 - 6: 企业电话 - 7: ip电话 - 8: webniar会议 - 9: 离线会议 - 10: 妙记会议 |
└ meeting_instance_id | string | 唯一会议ID |
└ number_of_webinar_viewers | string | 网络研讨会观众人数 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"meeting_list": [
{
"meeting_id": "705605196",
"meeting_topic": "讨论会",
"meeting_type": 1,
"organizer": "kehan",
"department": "development",
"user_id": "92f879",
"employee_id": "202105149765",
"email": "xxxx@163.com",
"mobile": "021-673288",
"meeting_start_time": "2022.12.23 11:16:59 (GMT+08:00)",
"meeting_end_time": "2022.12.23 11:18:51 (GMT+08:00)",
"meeting_duration": "00:01:52",
"number_of_participants": "1",
"number_of_devices": "1",
"audio": true,
"video": true,
"sharing": false,
"recording": false,
"telephone": false,
"reserved_rooms": [
{
"room_id": "omm_12381298739",
"room_name": "room123"
}
],
"has_related_document": false,
"ai_note": false,
"is_external": false,
"meeting_subtype": 1,
"meeting_instance_id": "7529416531681214468",
"number_of_webinar_viewers": "1"
}
],
"page_token": "20",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 121001 | internal error | 服务器内部错误,如果重试无效可联系管理员 |
| 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 year or smaller than start time | 结束时间不能超过开始时间一年或者小于开始时间 |
| 400 | 126008 | filter condition should be set only one | userID与roomID与会议号同时只能设置一个 |
| 400 | 126015 | not support room_id | 不支持用room_id筛选 |
| 400 | 126016 | end time cannot exceed start time for one month or smaller than start time for future schedule list | 待召开会议结束时间不能超过开始时间一个月或者小于开始时间 |
| 404 | 121004 | data not exist | 请求的数据不存在,请检查传入的ID是否正确或是否存在该数据 |
| 403 | 121005 | no permission | 无权限进行该操作,建议检查token类型、操作者身份以及资源的归属 |
