腾讯会议
容器与中间件专题文档捉虫活动邀您参加 > HOT
文档中心>腾讯会议>开放平台文档>服务端 API>REST APIs>会议管理>导出参会成员概览

导出参会成员概览

最近更新时间：2024-06-28 15:56:11

我的收藏

本页目录：

接口描述

使用场景：可用于导出参会成员单场会议的累计参会时长，用于教学、培训等场景的考勤分析等。
描述：
本接口为异步导出，导出结果查阅本文结尾 获取导出任务结果。
支持查询云会议和网络研讨会参会成员累计等参会时长等信息的概览。
如果会议还未开始，调用此接口查询会返回空列表。
企业 secret 鉴权用户（会议创建者）可获取任何该企业用户创建的有效会议中的参会成员。
企业 secret 鉴权用户（企业超级管理员）可获取任何该企业下创建的有效会议中的参会成员。
OAuth 2.0鉴权用户（会议创建者）只能获取用户通过 OAuth 2.0鉴权创建的有效会议中的参会成员。
注意：
调用该接口权限说明：
第三方应用需要拥有两个权限项点任何一个：查看您的会议、查看和管理您的会议。
自建应用（应用级）需要拥有两个权限项点任何一个：管理企业参会成员、查看企业参会成员。
请求方式：POST
接口请求域名：
https://api.meeting.qq.com/v1/meetings/export-participants-list

输入参数

以下请求参数列表仅列出了接口请求参数，HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称
必选
参数类型
参数描述
meetingId
是
String
会议的唯一 ID。
sub_meeting_id
否
String
周期性会议子会议 ID。说明：可通过查询用户的会议列表、查询会议接口获取返回的子会议 ID，即 current_sub_meeting_id；如果是周期性会议，此参数必传。
operator_id
否
String
操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值，operator_id 代表不同类型。
operator_id_type
否
Integer
操作者 ID 的类型： 1：企业用户 userid 2：OAuth 2.0鉴权用户请使用 openId 3：rooms 设备 rooms_id
start_time
否
int
参会时间过滤起始时间（单位秒）。说明：时间区间不允许超过31天，如果为空默认当前时间前推31天；start_time 和 end_time 都没传时最大查询时间跨度90天；对于周期性会议查询暂时不生效，请使用分页参数查询。
end_time
否
int
参会时间过滤终止时间（单位秒）。说明：时间区间不允许超过31天，如果为空默认取当前时间；start_time 和 end_time 都没传时最大查询时间跨度90天；对于周期性会议查询暂时不生效，请使用分页参数查询。
file_type
否
String
导出文件类型，默认为 xlsx；可支持文件类型：xlsx、json。

输出参数

参数名称
参数类型
参数描述
job_id
String
任务 ID。

错误码列表

状态码
错误码
错误描述
400
9003
会议信息不存在。
500
190001
存在未注册的用户。
400
190004
参数非法，请对照接口文档检查您的参数。

示例

输入示例

{
    "meeting_id": "144xxxxxxxxxxx234",
    "operator_id": "user_id_123",
    "operator_id_type": 1,
    "file_type":"xlsx"
}

输出示例

{
    "job_id": "zzlWxxxxxxxxxxxxxxxxiTs"
}

获取导出任务结果

可通过订阅通用 webhook 事件 异步任务结果 获取。
导出参会成员概览场景的 business_code 值为：meeting.export-meeting-participants-list，请参考下面示例中具体键值对的映射含义。

{
    "event": "common.job-results",
    "trace_id": "e7aa65dd-f7e6-4b62-912c-2035173b34a9",
    "payload": [
        {
            "operate_time": 1609313201465,
            "business_code": "meeting.export-meeting-participants-list", // 代表导出会议参会成员列表场景唯一标识，用于区分不同场景下返回的键值对含义
            "job_id": "xxxxxxxxxx", // 与异步操作关联的唯一id
            "job_status": 1, // 异步操作结果 1 成功 2 失败
            "error_msg": "", // 异步操作失败的错误信息
            "notify_info": { // 推送具体的任务信息
                "success": [
                    [
                        {
                            "key": "status",
                            "value": "xxxxx"
                        },
                        {
                            "key": "url",
                            "value": "xxxx"
                        }
                    ]
                ],
                "failed": [
                    [
                        {
                            "key": "status",
                            "value": "xxxx"
                        },
                        {
                            "key": "error_msg",
                            "value": "xxxx"
                        }
                    ]
                ]
            }
        }
    ]
}
可通过接口获取异步导出的结果，请参见 获取异步任务结果。

导出结果

导出结果包含会议信息+参会成员概览，具体字段可参考如下说明：

导出的会议信息字段对照

参数
参数类型
参数描述
meeting_id
String
会议的唯一 ID。
meeting_code
String
会议号码。
subject
String
会议主题。
schedule_start_time
String
预定会议开始时间戳（单位秒）。
schedule_end_time
String
预定会议结束时间戳（单位秒）。
meeting_total_duration
String
例：参会40分钟23秒，格式为0:40:23。
total_count
Int
当前参会总人次。

导出的参会成员概览字段对照

参数名称
参数类型
参数描述
userid
String
参会者用户 ID。
使用企业自建应用鉴权方式（JWT）时，该值为企业唯一用户标识。
open_id
String
已授权用户的 ID。
使用第三方应用鉴权方式（OAuth 2.0）时，该值为已授权用户的 open_id。
其他情况为空。
ms_open_id
String
当场会议的用户临时 ID，可用于会控操作，适用于所有用户。
user_name
String
入会用户名（base 64）。
is_enterprise_user
Boolean
是否是企业内部成员。
true：企业内成员，若 userid 为空且该字段为 true 表示已离职企业成员。
false：非企业内成员。
first_join_time
String
参会者加入会议时间戳（单位秒）。
last_left_time
String
参会者离开会议时间戳（单位秒）。
join_count
Int
参会人入会的次数。
join_total_duration
String
参会人本次会议累计的参会时长（示例：参会40分钟23秒，格式为0:40:23）。
instanceid
Integer
用户的终端设备类型：多端入会或者多次入会终端，记录首次入会终端。
0：PSTN
1：PC
2：Mac
3：Android
4：iOS
5：Web
6：iPad
7：Android Pad
8：小程序
9：voip、sip 设备（即 MRA 设备）
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/iPadOS
user_role
Integer
用户角色：多次入会，记录首次入会角色。
0：普通成员角色
1：创建者角色
2：主持人
3：创建者+主持人
4：游客
5：游客+主持人
6：联席主持人
7：创建者+联席主持人
webinar_member_role
Integer
网络研讨会成员角色：多次入会，记录首次入会角色。
0：普通参会角色
1：内部嘉宾
2：外部嘉宾
3：邀请链接入会嘉宾
4：观众
join_type
Integer
入会方式：多次入会，记录首次入会方式。
0：PSTN 普通用户，标准的手机或固话类型
1：普通 VOIP 用户
2：附属投屏 VOIP
3：linux sdk for VOIP
4：附属语音 PSTN
5：附属视频 PSTN
6：linux sdk for PSTN
net
String
网络类型：有线、WIFI、2G、3G、4G、未知。当用户在会中时才能返回。
app_version
String
用户的客户端版本。当用户在会中时才能返回。
audio_state
Bool
麦克风状态：多次入会，记录首次入会状态。
true：开启
false：关闭
video_state
Bool
摄像头状态： 多次入会，记录首次入会状态。
true：开启
false：关闭
screen_shared_state
Bool
屏幕共享状态：多次入会，记录首次入会状态。
true：开启
false：关闭
customer_data
String
如果参会成员是通过专属链接进会。
给出用户专属字段 。

导出结果示例

json 示例：导出文件类型 file_type 参数指定为 json 时，将结果返回为 json 文件。

{
    "meeting_id": "1448xxxxxxxxxxxxxx148",
    "meeting_code": "28xxxxxxxx42",
    "subject": "5rWL6K+V5Lya6K6u",
    "schedule_start_time": 1718444473,
    "schedule_end_time": 1718448073,
    "meeting_total_duration": "00:00:32",
    "total_count": 1,
    "participants": [
        {
            "userid": "userid123",
            "open_id": "openid123",
            "ms_open_id": "+1+BvNxxxxxxxxxxxxxxxxxuyeQ==",
            "user_name": "5rWL6K+V5aeT5ZCN",
            "is_enterprise_user": true,
            "first_join_time": "1718276018",
            "last_left_time": "1718276050",
            "join_count": 1,
            "join_total_duration": "00:00:32",
            "instanceid": 2,
            "user_role": 3,
            "webinar_member_role": 0,
            "join_type": 0,
            "net": "",
            "app_version": "",
            "audio_state": false,
            "video_state": false,
            "screen_shared_state": false,
            "customer_data": ""
        }
    ]
}
excel 示例：导出文件类型 file_type 参数指定为 xlsx 时，将结果返回为 excel 文件。如需获取全量，建议文件类型 file_type 参数指定为 json。
中国站
文档反馈
文档活动
message-icon联系我们
目录