Get registration form for a meeting
Get a meeting's registration form to understand which fields are required.
URI Parameters
Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the Meetings Overview for more information about meeting types.
Query Parameters
Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's true, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's false or not specified, return details for the entire meeting series. This parameter only applies to meeting series.
Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.
Response Properties
Whether or not meeting registration requests are accepted automatically.
Whether or not a registrant's first name is required for meeting registration. This option must always be true.
Whether or not a registrant's last name is required for meeting registration. This option must always be true.
Whether or not a registrant's email is required for meeting registration. This option must always be true.
Whether or not a registrant's job title is shown or required for meeting registration.
Whether or not a registrant's company name is shown or required for meeting registration.
Whether or not a registrant's first address field is shown or required for meeting registration.
Whether or not a registrant's second address field is shown or required for meeting registration.
Whether or not a registrant's city is shown or required for meeting registration.
Whether or not a registrant's state is shown or required for meeting registration.
Whether or not a registrant's postal code is shown or required for meeting registration.
Whether or not a registrant's country or region is shown or required for meeting registration.
Whether or not a registrant's work phone number is shown or required for meeting registration.
Whether or not a registrant's fax number is shown or required for meeting registration.
If true, generate random ID authentication for each registrant. Webinars only.
Customized questions for meeting registration.
Unique identifier for the question.
Title of the customized question.
Whether or not the customized question is required to be answered by participants.
Type of the question being asked.
Single line text box.
Multiple line text box.
Check box which requires options.
Drop down list box which requires options.
Single radio button which requires options.
The maximum length of a string that can be entered by the user, ranging from 0 to 999. Only required by singleLineTextBox and multiLineTextBox.
TThe content of options. Required if the question type is one of checkbox, dropdownList, or radioButtons.
The unique id of options.
The content of the option.
The automatic approval rules for customized questions.
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.
The approval rules for standard questions.
Name for standard question.
If the value is lastName, this approval rule applies to the standard question of "Last Name".
If the value is email, this approval rule applies to the standard question of "Email".
If the value is jobTitle, this approval rule applies to the standard question of "Job Title".
If the value is companyName, this approval rule applies to the standard question of "Company Name".
If the value is address1, this approval rule applies to the standard question of "Address 1".
If the value is address2, this approval rule applies to the standard question of "Address 2".
If the value is city, this approval rule applies to the standard question of "City".
If the value is state, this approval rule applies to the standard question of "State".
If the value is zipCode, this approval rule applies to the standard question of "Zip/Post Code".
If the value is countryRegion, this approval rule applies to the standard question of "Country Region".
If the value is workPhone, this approval rule applies to the standard question of "Work Phone".
If the value is fax, this approval rule applies to the standard question of "Fax".
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series.
- Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.
{
"autoAcceptRequest": false,
"requireFirstName": true,
"requireLastName": true,
"requireEmail": true,
"requireJobTitle": false,
"requireCompanyName": false,
"requireAddress1": false,
"requireAddress2": false,
"requireCity": false,
"requireState": false,
"requireZipCode": false,
"requireCountryRegion": false,
"requireWorkPhone": false,
"requireFax": false,
"enabledRegistrationId": false,
"customizedQuestions": [
{
"id": 330521,
"question": "How are you",
"required": true,
"type": "singleLineTextBox",
"options": [
{
"id": 1,
"value": "green"
}
],
"rules": [
{
"condition": "contains",
"value": "tom",
"result": "approve",
"matchCase": true,
"order": 1
}
]
}
],
"rules": [
{
"question": "state",
"condition": "contains",
"value": "tom",
"result": "approve",
"matchCase": true,
"order": 1
}
]
}