首页
企业微信
腾讯会议
企业邮箱
简道云
其它服务
联系我们
留言板

获取参会成员列表

接口描述

描述：会议拥有者获取某指定会议的参与人员列表。只有会议的拥有者即创建者可以查询参会成员的列表，其他用户的调用会被拒绝。如果会议还未开始，调用此接口查询会返回空列表。企业 secret 鉴权用户（会议创建者）可获取任何该企业该用户创建的有效会议中的参会成员，OAuth2.0 鉴权用户（会议创建者）只能获取用户通过 OAuth2.0 鉴权创建的有效会议中的参会成员。
当您需要实时监测参会成员入会状态或退会状态时，您可以通过订阅 用户入会 和 用户离会 的事件，接收事件通知。
调用方式：GET
接口请求域名：

https://api.meeting.qq.com/v1/meetings/{meetingId}/participants?userid={userId}&sub_meeting_id=1234454

输入参数

以下请求参数列表仅列出了接口请求参数，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 的类型：<br>3. rooms_id<br>说明：当前仅支持 rooms_id。如操作者为企业内 userid 或 openId，请使用 userid 字段。
userid 否 String 会议创建者的用户 ID（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。
pos 否 int 分页获取参会成员列表的查询起始位置值。当参会成员较多时，建议使用此参数进行分页查询，避免查询超时。此参数为非必选参数，默认值为0，从头开始查询。 设置每页返回的数量，请参考参数“size”的说明。查询返回输出参数“has_remaining”为 true，表示该会议人数较多，还有一定数量的参会成员需要继续查询。返回参数“next_pos”的值即为下一次查询的 pos 的值。多次调用该查询接口直到输出参数“has_remaining”值为 false。
size 否 int 拉取参会成员条数，目前每页支持最大100条。
start_time 否 int 参会时间过滤起始时间（单位秒）。说明：时间区间不允许超过31天，如果为空默认当前时间前推31天；start_time 和 end_time 都没传时最大查询时间跨度90天；对于周期性会议查询暂时不生效，请使用分页参数查询。
end_time 否 int 参会时间过滤终止时间（单位秒）。说明：时间区间不允许超过31天，如果为空默认取当前时间；start_time 和 end_time 都没传时最大查询时间跨度90天；对于周期性会议查询暂时不生效，请使用分页参数查询。

输出参数

<table>
<thead>
<tr>
<th>参数名称</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody><tr>
<td>meeting_id</td>
<td>String</td>
<td>会议的唯一 ID。</td>
</tr>
<tr>
<td>meeting_code</td>
<td>String</td>
<td>会议号码。</td>
</tr>
<tr>
<td>subject</td>
<td>String</td>
<td>会议主题。</td>
</tr>
<tr>
<td>schedule_start_time</td>
<td>String</td>
<td>预定会议开始时间戳（单位秒）。</td>
</tr>
<tr>
<td>schedule_end_time</td>
<td>String</td>
<td>预定会议结束时间戳（单位秒）。</td>
</tr>
<tr>
<td>participants</td>
<td>Array</a></td>
<td>参会人员对象数组。</td>
</tr>
<tr>
<td>has_remaining</td>
<td>boolean</td>
<td>是否还有未拉取的数据。</td>
</tr>
<tr>
<td>next_pos</td>
<td>int</td>
<td>和“has_remaining”一起，数据量比较大的情况下支持参会成员列表的多次获取。</td>
</tr>
<tr>
<td>total_count</td>
<td>int</td>
<td>当前参会总人次。</td>
</tr>
</tbody></table>

<span id=“Array”></span>

参会人员对象参数

参数名称 参数类型 参数描述
userid String 参会者用户 ID（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。
uuid String 用户唯一身份 ID，单场会议唯一。
user_name String 入会用户名（base64）。
phone String 参会者手机号 hash 值 SHA256（手机号 + “/” + secretid）。
join_time String 参会者加入会议时间戳（单位秒）。
left_time String 参会者离开会议时间戳（单位秒）。
instanceid Integer 用户的终端设备类型：<br>1：PC<br>2：Mac<br>3：Android<br>4：iOS<br>5：Web<br>6：iPad<br>7：Android Pad<br>8：小程序
user_role Integer 用户角色：<br>0：普通成员角色<br>1：创建者角色<br>2：主持人<br>3：创建者+主持人<br>4：游客<br>5：游客+主持人
ip String ip 地址。
location String 地理位置信息。
link_type String 连接方式：UDP、TCP、未知。
join_type Integer 入会方式：<br>0：PSTN 普通用户，标准的手机或固话类型<br>1：普通 VOIP 用户<br>2：附属投屏 VOIP<br>3：linux sdk for VOIP<br>4：附属语音 PSTN<br>5：附属视频 PSTN<br>6：linux sdk for PSTN
net String 网络类型：有线、WIFI、2G、3G、4G、未知。
app_version String 客户端版本。
audio_state Bool 麦克风状态：<br> true：开启<br>false：关闭
video_state Bool 摄像头状态： <br>true：开启<br>false：关闭
screen_shared_state Bool 屏幕共享状态：<br> true：开启<br>false：关闭

示例

示例1（单页）

输入示例

GET https://api.meeting.qq.com/v1/meetings/144115214488302892/participants?userid=owner1&size=20

输出示例

{
    "meeting_id":"144115214488302892",
    "meeting_code":"746950080",
    "subject":"Test Meeting",
    "schedule_start_time":"1572085800",
    "schedule_end_time":"1572089400",
    "has_remaining":false,
    "participants":[
        {
            "userid":"test1",
            "user_name":"dBVzdDE=",
            "phone":"0A07C3D999F5E29535D809857B5C44C51B819798542B241EC286F7DC828E0C01",
            "join_time":"1572085800",
            "left_time":"1572089400",
            "instanceid":1
        },
        {
            "userid":"test2",
            "user_name":"dGvzdDI=",
            "phone":"0A07C3D999F5E29535D809857B5C44C51B819798542B241EC286F7DC828E0C01",
            "join_time":"1572085800",
            "left_time":"1572089400",
            "instanceid":1
        }
    ]
}

示例2（多页）

输入示例（第一次拉取）

GET https://api.meeting.qq.com/v1/meetings/144115214488302892/participants?userid=owner1&size=1

输出示例

{
    "meeting_id":"144115214488302892",
    "meeting_code":"746950080",
    "subject":"Test Meeting",
    "schedule_start_time":"1572085800",
    "schedule_end_time":"1572089400",
    "has_remaining":true,
    "next_pos":5678,
    "participants":[
        {
            "userid":"test1",
            "user_name":"dBVzdDE=",
            "phone":"0A07C3D999F5E29535D809857B5C44C51B819798542B241EC286F7DC828E0C01",
            "join_time":"1572085800",
            "left_time":"1572089400",
            "instanceid":1
        }
    ]
}

输入示例（第二次拉取）

GET https://api.meeting.qq.com/v1/meetings/144115214488302892/participants?userid=owner1&pos=5678&size=1

输出示例

{
    "meeting_id":"144115214488302892",
    "meeting_code":"746950080",
    "subject":"Test Meeting",
    "schedule_start_time":"1572085800",
    "schedule_end_time":"1572089400",
    "has_remaining":false,
    "participants":[
        {
            "userid":"test2",
            "user_name":"dGvzdDI=",
    "phone":"0A07C3D999F5E29535D809857B5C44C51B819798542B241EC286F7DC828E0C01",
            "join_time":"1572085800",
            "left_time":"1572089400",
            "instanceid":1
        }
    ]
}
下载 腾讯会议API获取参会成员列表-腾讯会议.pdf
Copyright(C)2023 HFBangFu Inc. All Rights Reserved 皖ICP备12017563号-5
收缩