接口描述
描述:
会议创建者和企业超级管理员可以查询准备模式参会记录。
企业 secret 鉴权用户(会议创建者)可获取任何该企业创建的有效会议中的准备模式记录,企业 secret 鉴权用户(企业超级管理员)可获取任何该企业下创建的有效会议中的参准备模式记录,OAuth2.0鉴权用户(会议创建者)只能获取用户通过 OAuth2.0鉴权创建的有效会议中的准备模式记录。
请求方式:GET
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meetingId}/prepare-mode/details
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
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:open_id |
page | 否 | Integer | 页码,大于0,默认从1开始。 |
page_size | 否 | Integer | 分页大小,默认20,最小20,最大100。 |
start_time | 否 | Integer | 时间过滤起始时间时间戳(单位秒)。 说明: 只传 start_time,返回在 start_time 之后的记录。 传 start_time 和 end_time,返回该时间段内记录。 只传 end_time,返回 end_time 之前的记录。 若都不传,则返回全部记录。 |
end_time | 否 | Integer | 参会时间过滤终止时间时间戳(单位秒)。 说明: 只传 start_time,返回在 start_time 之后的记录。 传 start_time 和 end_time,返回该时间段内记录。 只传 end_time,返回 end_time 之前的记录。 若都不传,则返回全部记录。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
meeting_id | String | 会议的唯一 ID。 |
meeting_code | String | 会议号码。 |
subject | String | 会议主题。 |
schedule_start_time | String | 预定会议开始时间戳(单位秒)。 |
schedule_end_time | String | 预定会议结束时间戳(单位秒)。 |
details | Detail 对象数组 | 准备模式记录。 |
total_count | Integer | 分页查询返回数据总数。 |
total_page | Integer | 分页查询返回分页总数。 |
current_size | Integer | 分页查询返回单页数据条数。 |
current_page | Integer | 分页查询返回当前页码。 |
Detail 对象
参数名称 | 参数类型 | 参数描述 |
userid | String | 参会者用户 ID。使用企业自建应用鉴权方式(AK/SK)时,该值为企业唯一用户标识。 |
ms_open_id | String | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
open_id | String | 已授权用户的 ID。使用第三方应用鉴权方式(OAuth2.0)时,该值为已授权用户的 open_id。其他情况为空。 |
user_name | String | 入会用户名。 |
join_time | String | 参会者加入准备模式时间戳(单位秒)。 |
left_time | String | 参会者离开准备模式时间戳(单位秒)。 |
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 |
webinar_member_role | Integer | 网络研讨会成员角色: 1:内部嘉宾 2:外部嘉宾 3:邀请链接入会嘉宾 |
IP | String | 用户的 IP 地址。仅同企业成员会返回。 |
join_type | Integer | 入会方式: 0:PSTN 普通用户,标准的手机或固话类型 1:普通 VOIP 用户 2:附属投屏 VOIP 3:linux sdk for VOIP 4:附属语音 PSTN 5:附属视频 PSTN 6:linux sdk for PSTN |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 9003 | 会议信息不存在。 |
500 | 190001 | 存在未注册的用户。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/meetings/5678901234/prepare-mode/details?operator_id=user1&operator_id_type=1&page=1&page_size=100&sub_meeting_id=11123456
输出示例
{"meeting_id": "5678901234","meeting_code": "12345678","subject": "准备模式_周期会议","schedule_start_time": "1686558600","schedule_end_time": "1686735000","details": [{"userid": "user2","ms_open_id": "xxxxxxxxxxxxxxxxxxxxxxxxx","open_id": "xxxxxxxxxxxxx","user_name": "准备模式用户","join_time": "1686213902","left_time": "1686214104","instanceid": 0,"webinar_member_role": 3,"ip": "XXX.XXX.XXX.XXX","join_type": 4}],"total_count": 1,"total_page": 1,"current_page": 1,"current_size": 1}