接口描述
描述:在指定网络研讨会(Webinar)中导入报名信息。
企业 secret 鉴权用户可通过同企业下用户 userid 和手机号导入报名信息,OAuth2.0鉴权用户能通过用户 open_id,与应用同企业下的 userid 以及手机号导入报名信息。
用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。
商业版单场会议导入上限1000条,企业版单场会议导入上限4000条。如需提升,请 联系我们。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/webinars/{meeting_id}/enroll/import
输入参数
参数名称 | 参数类型 | 是否必须 | 参数描述 |
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 |
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 |
enroll_list | Enroll 对象数组 | 必须 | 报名对象列表。 |
Enroll 对象
参数名称 | 参数类型 | 是否必须 | 参数描述 |
open_id | String | 非必须 | OAuth 授权用户 ID。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 如果都传了以 openid 为准。 AK/SK 鉴权方式无法使用 open_id 导入报名。 |
userid | String | 非必须 | 企业内的用户的唯一 ID。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 |
area | String | 非必须 | 国家/地区代码。若使用 phone_number 的方式导入,该字段必填(例如:中国传86,不是+86)。 |
phone_number | String | 非必须 | 手机号。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 |
nick_name | String | 非必须 | 报名的昵称。此处的修改不会影响会中展示的昵称,仅展示在导出的报名信息。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
total_count | Integer | 成功导入的报名信息条数。 |
enroll_list | Enrol 对象数组 | 报名对象列表。 |
user_non_registered | String 数组 | 通过 userid 方式导入时,本企业内未注册用户。返回未注册的 userid 数组。 |
Enrol 对象
参数名称 | 参数类型 | 参数描述 |
enroll_id | Integer | 报名 ID。 |
open_id | String | OAuth 授权用户 ID。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 |
userid | String | 企业内的用户的唯一 ID。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 |
area | String | 国家/地区代码。若使用 phone_number 的方式导入,该字段必填(例如:中国传86,不是+86)。 |
phone_number | String | 手机号。 导入报名对象支持本企业(AK/SK 模式)或应用同企业(OAuth 模式)内 userid、授权用户的 openid、phone_number 三种形式,三者必填其一。 |
nick_name | String | 报名的昵称。 |
enroll_code | String | 报名码,用于电话入会的凭证。 |
示例
输入示例
POST https://api.meeting.qq.com/v1/webinars/100001/enroll/import{"instanceid": 1,"operator_id": "user1","operator_id_type":1,"enroll_list": [{"area":"86","phone_number":"13612111111"},{"userid":"123"}]}
输出示例
{"total_count": 1,"enroll_list": [{"userid":"user1","area":"86","phone_number":"13612111111","nick_name":"ccc","enroll_code":"111","enroll_id":1351111,"open_id":""}],"user_non_registered":["123"]}