查询会议报名配置

最近更新时间:2024-11-11 09:42:21

我的收藏

接口描述

描述:查询会议的报名配置和报名问题,仅会议创建者可查询。
会议未开启报名时会返回未开启报名错误。
企业 secret 鉴权用户可查询任何该企业该用户创建的有效会议,OAuth2.0 鉴权用户只能查询通过 OAuth2.0 鉴权创建的有效会议。
用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。
请求方式:GET
接口操作者权限点:需具备会议创建者身份方可调用。
接口请求域名
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 一致。
operator_id 和 userid 至少填写一个,两个参数如果都传了以 operator_id 为准。
使用 OAuth 公参鉴权后不能使用 userid 为入参。
operator_id_type
Integer
操作者 ID 的类型:
1:userid
2:open_id
如果 operator_id 和 userid 具有值,则以 operator_id 为准。
userid
String
会议创建者的用户 ID。为了防止现网应用报错,此参数实则仍然兼容 openid,如无 oauth 应用使用报名接口则也可做成不兼容变更。
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

输出参数

参数名称
参数类型
参数描述
approve_type
Integer
审批类型:
1:自动审批,默认自动审批
2:手动审批
is_collect_question
Integer
是否收集问题:
1:不收集,默认不收集问题
2:收集
meeting_id
String
会议的唯一标识。
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:邮件通知(需通过设置报名问题收集报名者邮箱)
display_number_of_participants
integer
显示已报名/预约人数。
0:不展示
1:展示,默认开启
cover_image
String[]
报名封面图链接(base64 编码)列表。
enroll_description
String
报名页简介(base64 编码)。

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
-

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
500
1
params invalid。
500
190001
存在未注册的用户。
500
101
会议未开启报名。
500
107
查询权限不足。

示例

输入示例

GET https://api.meeting.qq.com/v1/meetings/100001/enroll/config?instanceid=2&user_id=user1

输出示例

{
"meeting_id": "100001",
"approve_type": 1,
"is_collect_question": 2,
"no_registration_needed_for_staff": false,
"question_list": [{
"is_required":2,
"question_type":3,
"question_title":"手机号",
"special_type":2
}]
}