List registration questions

GET

/webinars/{webinarId}/registrants/questions

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
Prerequisites:

Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/webinars//registrants/questions'

响应示例

200 - response

{
    "custom_questions": [
        {
            "answers": [
                "array of answer choices"
            ],
            "required": "boolean",
            "title": "string",
            "type": "string"
        }
    ],
    "questions": [
        {
            "field_name": "string",
            "required": "boolean"
        }
    ]
}

请求参数

Path 参数

webinarId

integer <int64>

必需

The webinar ID in "long" format(represented as int64 data type in JSON).

返回响应

🟢200**HTTP Status Code:** `200`<br> Webinar Registrant Question object returned

application/json

Body

Webinar Registrant Questions

custom_questions

array [object {4}]

可选

Array of Registrant Custom Questions.

answers

array[string]

可选

An array of answer choices. Can't be used for short answer type.

required

boolean

可选

State whether or not the custom question is required to be answered by a registrant.

title

string

可选

Custom question.

type

enum<string>

可选

The question-answer type.

枚举值:

shortsingle_radiosingle_dropdownmultiple

questions

array [object {2}]

可选

Array of registration fields whose values should be provided by registrants during registration.

field_name

enum<string>

可选

Field name

枚举值:

last_nameaddresscitycountryzipstatephoneindustryorgjob_titlepurchasing_time_framerole_in_purchase_processno_of_employeescomments

required

boolean

可选

State whether the selected fields are required or optional.

🟠404**HTTP Status Code:** `404`<br>Webinar not found

修改于 2024-04-24 09:06:48

Add a webinar registrant

Update registration questions