接口描述
描述:修改会议的报名配置和报名问题,仅会议创建者可修改,且需要会议已开启报名。
企业 secret 鉴权用户可修改任何该企业用户创建的有效会议,OAuth 2.0鉴权用户只能修改通过 OAuth 2.0鉴权创建的有效会议。
用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。
请求方式:PUT
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/enroll/config
输入参数
参数名称 | 参数类型 | 必选 | 参数描述 |
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 |
approve_type | Integer | 否 | 审批类型: 1:自动审批,默认自动审批。 2:手动审批。 |
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 |
is_collect_question | Integer | 否 | 是否收集问题: 1:不收集,默认不收集问题。 2:收集。 |
question_list | Question 对象数组 | 否 | 报名问题列表,非特殊问题按传入的顺序排序,特殊问题会优先放在最前面,仅开启收集问题时有效。 |
no_registration_needed_for_staff | Boolean | 否 | 本企业用户无需报名。 true:本企业用户无需报名。 false:默认配置,本企业用户及企业外用户需要报名。 |
enroll_number | Integer | 否 | 报名人数上限。 默认为会议人数上限,设置报名人数最少为1个。 |
enroll_deadline | String | 否 | 报名截止时间(秒级时间戳)。 默认无截止时间,截止时间需大于当前时间。 |
enroll_push_type | Integer[] | 否 | 报名审批自动通知方式,支持多选。 0:不通知 1:短信通知 2:邮件中文(需通过设置报名问题收集报名者邮箱) 3:邮件英文(需通过设置报名问题收集报名者邮箱) 4:邮件中英文(需通过设置报名问题收集报名者邮箱) 5:公众号 注意:默认公众号通知,不传或者传空列表则不做修改。 |
display_number_of_participants | integer | 否 | 显示已报名/预约人数。 0:不展示 1:展示,默认开启 |
cover_image | String[] | 否 | 报名封面图的 URL,上传封面为异步形式,通过 异步任务结果 事件获取上传结果,内容为空字符串时为默认图片,不传或传空列表则不做修改,最多支持5张,支持格式为jpg、jpeg、png。每张不超过5M,按照传入顺序展示。 |
enroll_description | String | 否 |
Question 对象
参数名称 | 参数类型 | 必选 | 参数描述 |
is_required | Integer | 是 | 是否必填: 1:否 2:是 |
option_list | Option 对象数组 | 否 | 问题选项列表,按传入的顺序排序,仅单选和多选时有效,最多12个选项,每个选项限40个汉字。 |
question_title | String | 否 | 问题标题,限制40个字符。 说明:special_type 为特殊问题时,该字段无效。 |
question_type | Integer | 否 | 问题类型: 1:单选 2:多选 3:简答 说明:special_type 为特殊问题时,该字段无效。 |
special_type | Integer | 否 | 特殊问题类型: 1:无 2:手机号 3:邮箱 4:姓名 5:组织名称 6:组织规模 说明:目前除组织规模外均为简答题,组织规模为单选题。 |
Option 对象
参数名称 | 参数类型 | 必选 |
content | String | 否 |
输出参数
参数名称 | 参数类型 | 参数描述 |
meeting_id | String | 会议的唯一标识。 |
question_count | Integer | 报名问题数量,不收集问题时该字段返回0。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 190303 | 鉴权失败,场景: 1. 企业内部应用鉴权时,请检查请求头公共参数里字段 AppId 和 X-TC-Key 内容是否正确,字段 SdkId 如未分配不要携带。 2. OAuth 2.0鉴权时请检查 AccessToken 是否过期或权限点不足。 |
500 | 107 | 查询权限不足。 |
500 | 1 | params invalid。 |
500 | 190001 | 存在未注册的用户。 |
500 | 129 | 会议已结束。 |
500 | 101 | 会议未开启报名。 |
示例
输入示例
PUT https://api.meeting.qq.com/v1/meetings/100001/enroll/config{"operator_id":"KM4Ss4Th09ogUw1JiK","operator_id_type":1,"instanceid": 2,"question_list": [{"is_required": 2,"special_type": 2,"question_title": "手机号"}],"no_registration_needed_for_staff": false}
输出示例
{"meeting_id": "100001","question_count": 1}