获取实时会中成员列表 - 接口文档

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 会议预约会议高级管理获取实时会中成员列表

获取实时会中成员列表

最后更新：2023/04/25

获取当前会中成员列表，仅包括会中的成员。如果成员已离会，则不返回。

请求方式： POST（HTTPS）
请求地址： https://qyapi.weixin.qq.com/cgi-bin/meeting/get_realtime_attendee_list?access_token=ACCESS_TOKEN

请求包体：

{
	"meetingid":"meetingid11234",
	"sub_meetingid":"submeetingid11111",
	"cursort":"NGIEMG",
	"limit":50
}

参数说明：

参数	必须	类型	说明
access_token	是	string	调用接口凭证。获取方法查看“获取access_token”
meetingid	是	string	会议id
sub_meetingid	否	string	周期性会议子会议 ID。说明：可通过查询成员的会议列表、查询会议接口获取返回的子会议 ID，即 current_sub_meeting_id。如果是周期性会议，此参数必传。
cursor	否	string	分页查询用，将上一个请求返回的next_cursor字段传入。第一次查询时可不传值
limit	否	uint32	单次查询返回的数量，最大50条。

注意：
limit参数必须与首次调用获得cursor时传入的limit一致。

权限说明

仅配置在“可调用接口的应用”列表中的自建应用可调用
仅允许获取该应用创建的会议的数据
仅返回在应用可见范围内的成员

返回结果：

{
	"errcode": 0,
	"errmsg": "ok",
	"status": "1",
	"has_more": true,
	"next_cursor": "JGIEGNOE",
	"attendees": [{
		"userid": "lisi",
		"tmp_openid": "111111",
		"join_time": "166666666",
		"instance_id": 1,
		"role": 0,
		"join_type": 0,
		"audio_state": true,
		"video_state":true,
		"screen_shared_state": true
	}]
}

参数说明

参数	类型	说明
errcode	int32	返回码
errmsg	string	对返回码的文本描述内容
has_more	bool	是否还有更多的成员列表
next_cursor	string	分页用，下一次拉取列表将该字段填入cursor字段
attendees	object[]	参会人列表，详见Attendee

Attendee说明

参数	类型	说明
userid	string	企业内参会成员userid
tmp_userid	string	外部联系人临时ID
join_time	string	参会者加入会议时间戳（单位秒）。
instance_id	uint32	成员的终端设备类型： 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
role	uint32	成员角色： 0：普通成员角色 1：创建者角色 2：主持人 3：创建者+主持人 4：游客 5：游客+主持人 6：联席主持人 7：创建者+联席主持人
join_type	uint32	入会方式： 0：PSTN 普通用户，标准的手机或固话类型 1：普通 VOIP 用户 2：附属投屏 VOIP 3：linux sdk for VOIP 4：附属语音 PSTN 5：附属视频 PSTN 6：linux sdk for PSTN
audio_state	bool	麦克风状态： true：开启 false：关闭
video_state	bool	摄像头状态： true：开启 false：关闭
screen_shared_state	bool	屏幕共享状态： true：开启 false：关闭

获取用户专属参会链接

获取已参会成员列表

本节内容

获取实时会中成员列表