接口描述
描述:会中会议创建者和会议主持人可以导出一次签到的签到记录,会外会议创建者可以导出签到记录。
请求方式:GET
鉴权方式:AK/SK 鉴权、OAuth2.0鉴权
权限点:会议管理
接口请求域名:
https://api.meeting.qq.com/v1/meetings/sign-in
输入参数
参数名称 | 是否必须 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid 2:openid 4:ms_open_id |
operator_id | 是 | String | 操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
instanceid | 是 | Integer | 用户的终端设备类型: 0:PSTN 1:PC 2:Mac 3:Android 4:iOS 5:Web 6:iPad 7:Android Pad 8:小程序 9:voip、sip 设备 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 |
sign_in_id | 是 | String | 签到 ID。 |
page | 否 | Integer | 当前页,页码起始值为1。 |
page_size | 否 | Integer | 分页大小,默认10,最大50条。 |
输出参数
参数名称 | 是否必须 | 参数类型 | 参数描述 |
total_count | 是 | Integer | 数据总条数。 |
current_size | 是 | Integer | 当前页数据条数。 |
total_page | 是 | Integer | 总页数。 |
current_page | 是 | Integer | 当前页码。 |
events | 是 | Event 对象列表 | 签到记录。 |
sign_in_id | 是 | String | 签到 ID。 |
start_time | 是 | Integer | 签到开始时间戳(秒)。 |
sign_in_specification | 是 | String | 签到说明。 |
Event 对象
参数名称 | 是否必须 | 参数类型 | 参数描述 |
ms_open_id | 是 | String | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
userid | 否 | String | 企业唯一用户标识,当与主持人为同企业时返回 userid。 |
open_id | 是 | String | 已授权用户的 ID。使用第三方应用鉴权方式(OAuth2.0)时,该值为已授权用户的 open_id。其他情况为空。 |
user_name | 是 | String | 用户昵称。 |
user_role | 是 | String | 用户角色: 0:普通成员角色 1:创建者角色 2:主持人 3:创建者+主持人 4:游客 5:游客+主持人 6:联席主持人 7:创建者+联席主持人 |
webinar_member_role | 是 | String | 网络研讨会成员角色: 0:普通参会角色 1:内部嘉宾 2:外部嘉宾 3:邀请链接入会嘉宾 4:观众 |
sign_in_time | 是 | String | 签到时间,按时间正序排列。 |
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 500048 | meeting_id 参数有误。 |
500 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 101 | 无权限操作,必须为会议创建者。 |
500 | 503 | 获取用户信息失败。 |
500 | 102 | 无权限操作,必须为会议主持人或创建者。 |
500 | 400 | 参数错误。 |
500 | 501 | 获取会议信息失败。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/meetings/sign-in?meeting_id=123456789&sign_in_id=S42CD414A-6EBD-XXXX-XXXX-C6437FC76741&operator_id_type=1&operator_id=test_operator_id&page=1&page_size=20&instanceid=2
输出示例
{"total_count": 1,"current_size": 20,"total_page": 1,"current_page": 1,"sign_in_id": "S42CD414A-6EBD-XXXX- XXXX-C6437FC76741","start_time": 1684315462,"sign_in_specification": "test_sign_in","events": [{"ms_open_id": "test_ms_open_id","userid": "","open_id": "","user_name": "test_operator_id","user_role": "3","webinar_member_role": "0","sign_in_time": 1684315462}]}