接口描述
描述: 支持查询网络研讨会中已报名成员的报名 ID,仅会议创建者可查询。
可通过会中成员的 ms_open_id 查询到对应的报名 ID,成员的 ms_open_id 可通过 获取参会成员列表 接口获取。
成员的报名 ID 在每场会议是唯一的,可以通过 查询会议报名信息 接口匹配其对应的报名信息。
如果传入的成员没有报名,则不会返回该成员的 ms_open_id 和报名 ID。
企业 secret 鉴权用户可查询任何该企业该用户创建的有效会议,OAuth2.0 鉴权用户只能查询通过 OAuth2.0 鉴权创建的有效会议。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/webinars/{meeting_id}/enroll/ids
输入参数
参数名称 | 是否必须 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。会议创建者可以导入报名信息。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 operator_id_type=2,operator_id 必须和公共参数的 openid 一致。 说明:使用 OAuth 公参鉴权后不能使用 userid 为入参。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid 2:open_id |
meeting_id | 是 | String | 会议 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 |
sorting_rules | 否 | Integer | 查询报名 ID 的排序规则。当该账号存在多条报名记录(手机号导入、手动报名等)时,该接口返回的顺序。 1:优先查询手机号导入报名,再查询用户手动报名,默认值。 2:优先查询用户手动报名,再查手机号导入。 |
ms_open_id_list | 是 | String 数组 | 当场会议的用户临时 ID(适用于所有用户)数组,单次最多支持500条。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
meeting_id | String | 会议 ID。 |
enroll_id_list | 成员报名 ID 对象数组 | 成员报名 ID 数组,仅返回已报名成员的报名 ID,若传入的用户无人报名,则无该字段。 |
成员报名 ID 对象
参数名称 | 参数类型 | 参数描述 |
ms_open_id | String | 当场会议的用户临时 ID,适用于所有用户。 |
enroll_id | Integer | 报名 ID。 |
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 101 | 会议未开启报名。 |
400 | 190301 | 请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。 |
500 | 107 | 查询权限不足。 |
500 | 41 | 获取会议信息失败,请稍后重试。 |
500 | 190001 | 存在未注册的用户。 |
500 | 20011 | 无效的 ms_open_id。 |
500 | 960000 | 网络错误,请稍后重试。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
示例
输入示例
POSThttps://api.meeting.qq.com/v1/webinars/879648049490689475/enroll/ids{"operator_id":"KM4Ss4Th09ogUw1JiK","operator_id_type":1,"instanceid": 2,"ms_open_id_list": ["agaqwwgdkkddd","ahfsdugkjsdg","jhgsddgskjh"]}
输出示例
{"meeting_id": "545613049490456875","enroll_id_list": [{"ms_open_id": "agaqwwgdkkddd","enroll_id": 1386442},{"ms_open_id": "ahfsdugkjsdg","enroll_id": 9896426},{"ms_open_id": "jhgsddgskjh","enroll_id": 6983563}]}