Skip to content

获取会议详情

根据会议 ID 获取指定会议的详细信息,包括会议主题、链接、主持人、参会人员、状态、时间信息及关联纪要 ID。

Warning: 只能获取归属于自己的会议,支持查询最近90天内的会议

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/vc/v1/meetings/:meeting_id
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可vc:meeting.meetingevent:read 获取会议信息 vc:meeting:readonly 获取会议信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID vc:meeting.artifact.note:read 获取智能纪要信息 vc:meeting.artifact.verbatim:read 获取逐字稿信息

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
meeting_idstring会议ID(视频会议的唯一标识,视频会议开始后才会产生)可通过调用获取与会议号关联的会议列表获取
示例值:"6911188411932033028"

查询参数

名称类型必填描述
with_participantsboolean是否返回参会人列表,默认值为 false,不返回参会人列表;设为 true 时返回参会人列表。当 user_id_type 为 user_id 时,参会人列表仅能获取 Lark 用户。
示例值:false
with_meeting_abilityboolean是否返回会中使用能力统计,默认值为 false,不返回能力统计;设为 true 时返回会中使用能力统计(仅限tenant_access_token)
示例值:false
user_id_typestring用户 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
query_modeint此次查询的查询模式,不传,或传0,只查询会议信息;传1,只查询会议产物
示例值:0
可选值有
- 0: 只查询会议信息(默认) - 1: 只查询会议产物(纪要、逐字稿)

注意:使用user_id作为user_id_type时,参会人列表中仅能获取lark用户,rooms/pstn/sip等用户将被过滤。如需获取此类用户,请使用open_id

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ meetingmeeting会议数据
    └ idstring会议ID(视频会议的唯一标识,视频会议开始后才会产生)
    └ topicstring会议主题
    └ urlstring会议链接(飞书用户可通过点击会议链接快捷入会)
    └ meeting_nostring会议号
    └ passwordstring会议密码
    └ create_timestring会议创建时间(unix时间,单位sec)
    └ start_timestring会议开始时间(unix时间,单位sec)
    └ end_timestring会议结束时间(unix时间,单位sec)
    └ host_usermeeting_user主持人
      └ idstring用户ID
      └ user_typeint用户类型
可选值有
- 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户
    └ meeting_connectboolean该会议是否支持互通
    └ statusint会议状态
可选值有
- 1: 会议呼叫中 - 2: 会议进行中 - 3: 会议已结束
    └ participant_countstring参会峰值人数
    └ participant_count_accumulatedstring累计参会人数
    └ participantsmeeting_participant\[\]参会人列表
      └ idstring用户ID
      └ first_join_timestring首次入会时间,秒级Unix时间戳
      └ final_leave_timestring最终离会时间,秒级Unix时间戳
      └ in_meeting_durationstring累计在会中时间,时间单位:秒
      └ user_typeint用户类型
可选值有
- 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户
      └ is_hostboolean是否为主持人
      └ is_cohostboolean是否为联席主持人
      └ is_externalboolean是否为外部参会人
      └ statusint参会人状态
可选值有
- 1: 呼叫中 - 2: 在会中 - 3: 正在响铃 - 4: 不在会中或已经离开会议
    └ abilitymeeting_ability会中使用的能力
注意:仅当使用应用身份(tenant_access_token)调用该接口,且查询参数 with_meeting_ability 取值为 true 时,该参数会有返回值。
      └ use_videoboolean是否使用视频
      └ use_audioboolean是否使用音频
      └ use_share_screenboolean是否使用共享屏幕
      └ use_follow_screenboolean是否使用妙享(magic share)
      └ use_recordingboolean是否使用录制
      └ use_pstnboolean是否使用PSTN
    └ note_idstring纪要ID
  └ related_artifactsmeeting_related_artifacts会议产物相关信息
    └ note_doc_tokenstring智能纪要的 doc_token - 文档一旦生成,就可以查到对应 token - 无字段权限时,该 key 不会出现在 related_artifacts 结构当中 - 有字段权限而无内容时,related_artifacts 结构中会包含该 key,同时其值为空字符串
字段权限要求vc:meeting.artifact.note:read 获取智能纪要信息
    └ verbatim_doc_tokenstring逐字稿的 doc_token - 文档一旦生成,就可以查到对应 token - 无字段权限时,该 key 不会出现在 related_artifacts 结构当中 - 有字段权限而无内容时,related_artifacts 结构中会包含该 key,同时其值为空字符串
字段权限要求vc:meeting.artifact.verbatim:read 获取逐字稿信息

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "meeting": {
            "id": "6911188411934433028",
            "topic": "my meeting",
            "url": "https://vc.feishu.cn/j/337736498",
            "meeting_no": "123456789",
            "password": "971024",
            "create_time": "1608885566",
            "start_time": "1608883322",
            "end_time": "1608888867",
            "host_user": {
                "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
                "user_type": 1
            },
            "status": 2,
            "participant_count": "10",
            "participant_count_accumulated": "10",
            "participants": [
                {
                    "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
                    "first_join_time": "1624438144",
                    "final_leave_time": "1624438144",
                    "in_meeting_duration": "123",
                    "user_type": 1,
                    "is_host": true,
                    "is_cohost": false,
                    "is_external": false,
                    "status": 2
                }
            ],
            "ability": {
                "use_video": true,
                "use_audio": true,
                "use_share_screen": true,
                "use_follow_screen": true,
                "use_recording": true,
                "use_pstn": true
            }
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
500121001internal error服务器内部错误,如果重试无效可联系技术支持
400121002not support暂不支持该功能,有疑问可联系技术支持
400121003param error参数错误,检查参数的取值范围(请按照上面字段说明自查)
404121004data not exist请求的数据不存在,请确保传入了正确的会议ID(meeting_id),如何获取会议ID,可参考获取与会议号关联的会议列表
403121005no permission无权限进行该操作,建议检查token类型、操作者身份以及资源的归属

内容来源:飞书开放平台 · 自动爬取整理