ReportsWebinarParticipantsListResponse
{
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The number of records returned within a single API call."
},
"page_count": {
"type": "integer",
"example": 1,
"description": "The number of pages returned for the request made."
},
"participants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ABCDEF123456",
"description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."
},
"name": {
"type": "string",
"example": "jchill",
"description": "The participant's display name. This returns an empty string value if the account calling the API is a BAA account."
},
"status": {
"enum": [
"in_meeting",
"in_waiting_room"
],
"type": "string",
"example": "in_meeting",
"description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
},
"user_id": {
"type": "string",
"example": "ABCDEF123456",
"description": "The participant's ID. This ID is assigned to the participant upon joining the webinar and is only valid for that webinar."
},
"duration": {
"type": "integer",
"example": 20,
"description": "The participant's attendance duration."
},
"failover": {
"type": "boolean",
"example": false,
"description": "Whether failover occurred during the webinar."
},
"join_time": {
"type": "string",
"format": "date-time",
"example": "2019-02-01T12:34:12.660Z",
"description": "The participant's join time."
},
"leave_time": {
"type": "string",
"format": "date-time",
"example": "2019-02-01T12:54:12.660Z",
"description": "The participant's leave time."
},
"user_email": {
"type": "string",
"example": "jchill@example.com",
"pattern": "(^\\s*$|^[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+(\\.[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,})$)",
"description": "The participant's email address. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us) for details. This returns an empty string value if the account calling the API is a BAA account."
},
"customer_key": {
"type": "string",
"example": "349589LkJyeW",
"maxLength": 35,
"description": "The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 35 characters."
},
"registrant_id": {
"type": "string",
"example": "123456FEDCBA",
"description": "The registrant's ID. This field only returns if you provide the `registrant_id` value for the `include_fields` query parameter."
},
"participant_user_id": {
"type": "string",
"example": "DYHrdpjrS3uaOf7dPkkg8w",
"description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."
}
}
},
"description": "Information about the webinar participant."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The number of all records available across pages."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"description": "Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
}
},
"description": "Pagination object."
}
SipPhoneEnableUserSipPhoneRequest
{
"type": "object",
"required": [
"authorization_name",
"domain",
"password",
"proxy_server",
"register_server",
"user_email",
"user_name",
"voice_mail"
],
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 64,
"description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
},
"password": {
"type": "string",
"example": "123456",
"description": "The password generated for the user in the SIP account."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"maxLength": 64,
"description": "The phone number associated with the user in the SIP account."
},
"user_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"maxLength": 64,
"description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
},
"voice_mail": {
"type": "string",
"example": "4000",
"maxLength": 255,
"description": "The number to dial for checking voicemail."
},
"proxy_server": {
"type": "string",
"example": "192.0.2.2",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
},
"proxy_server2": {
"type": "string",
"example": "192.0.2.4",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"proxy_server3": {
"type": "string",
"example": "192.0.2.6",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"register_server": {
"type": "string",
"example": "192.0.2.1",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server2": {
"type": "string",
"example": "192.0.2.3",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server3": {
"type": "string",
"example": "192.0.2.5",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"authorization_name": {
"type": "string",
"example": "testname",
"maxLength": 64,
"description": "The authorization name of the user that is registered for SIP phone."
},
"transport_protocol": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol2": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol3": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"registration_expire_time": {
"type": "integer",
"default": 60,
"example": 60,
"maximum": 127,
"minimum": 1,
"description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
}
}
}
SipPhoneEnableUserSipPhoneResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123456",
"description": "The SIP phone ID."
},
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 64,
"description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
},
"password": {
"type": "string",
"example": "123456",
"description": "The password generated for the user in the SIP account."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"maxLength": 64,
"description": "The phone number associated with the user in the SIP account."
},
"user_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"maxLength": 64,
"description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
},
"voice_mail": {
"type": "string",
"example": "4000",
"maxLength": 255,
"description": "The number to dial for checking voicemail."
},
"proxy_server": {
"type": "string",
"example": "192.0.2.2",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
},
"proxy_server2": {
"type": "string",
"example": "192.0.2.4",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"proxy_server3": {
"type": "string",
"example": "192.0.2.6",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"register_server": {
"type": "string",
"example": "192.0.2.1",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server2": {
"type": "string",
"example": "192.0.2.3",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server3": {
"type": "string",
"example": "192.0.2.5",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"authorization_name": {
"type": "string",
"example": "testname",
"maxLength": 64,
"description": "The authorization name of the user that is registered for SIP phone."
},
"transport_protocol": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol2": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol3": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"registration_expire_time": {
"type": "integer",
"default": 60,
"example": 60,
"maximum": 127,
"minimum": 1,
"description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
}
}
}
SipPhoneListResponse
{
"type": "object",
"properties": {
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123456",
"description": "The SIP phone ID."
},
"domain": {
"type": "string",
"example": "example.com",
"description": "The name or IP address of your provider's SIP domain."
},
"password": {
"type": "string",
"example": "apassword1",
"description": "The password generated for the user in the SIP account.\n"
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"description": "The phone number associated with the user in the SIP account. "
},
"user_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
},
"voice_mail": {
"type": "string",
"example": "4000",
"description": "The number to dial for checking voicemail."
},
"proxy_server": {
"type": "string",
"example": "192.0.2.2",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"proxy_server2": {
"type": "string",
"example": "192.0.2.4",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"proxy_server3": {
"type": "string",
"example": "192.0.2.6",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
},
"register_server": {
"type": "string",
"example": "192.0.2.1",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server2": {
"type": "string",
"example": "192.0.2.3",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server3": {
"type": "string",
"example": "192.0.2.5",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"authorization_name": {
"type": "string",
"example": "testname",
"description": "The authorization name of the user that is registered for SIP phone."
},
"transport_protocol": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol2": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol3": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"registration_expire_time": {
"type": "integer",
"example": 60,
"description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server. "
}
}
},
"description": "SIP phones object."
},
"page_size": {
"type": "integer",
"example": 30,
"description": "The number of records returned within a single API call."
},
"page_count": {
"type": "integer",
"example": 1,
"description": "The number of pages returned for the request made."
},
"page_number": {
"type": "integer",
"example": 1,
"description": "The page number of the current results."
},
"total_records": {
"type": "integer",
"example": 20,
"description": "The total number of all the records available across pages."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"
}
}
}
SipPhoneUpdateSpecificPhoneRequest
{
"type": "object",
"required": [
"authorization_name",
"domain",
"password",
"proxy_server",
"proxy_server2",
"proxy_server3",
"register_server",
"register_server2",
"register_server3",
"user_name",
"voice_mail"
],
"properties": {
"domain": {
"type": "string",
"example": "example.com",
"maxLength": 64,
"description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
},
"password": {
"type": "string",
"example": "123456",
"description": "The password generated for the user in the SIP account."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"maxLength": 64,
"description": "The phone number associated with the user in the SIP account."
},
"voice_mail": {
"type": "string",
"example": "4000",
"maxLength": 255,
"description": "The number to dial for checking voicemail."
},
"proxy_server": {
"type": "string",
"example": "192.0.2.2",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
},
"proxy_server2": {
"type": "string",
"example": "192.0.2.4",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
},
"proxy_server3": {
"type": "string",
"example": "192.0.2.6",
"description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
},
"register_server": {
"type": "string",
"example": "192.0.2.1",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server2": {
"type": "string",
"example": "192.0.2.3",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"register_server3": {
"type": "string",
"example": "192.0.2.5",
"description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
},
"authorization_name": {
"type": "string",
"example": "testname",
"maxLength": 64,
"description": "The authorization name of the user that is registered for SIP phone."
},
"transport_protocol": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol2": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"transport_protocol3": {
"enum": [
"UDP",
"TCP",
"TLS",
"AUTO"
],
"type": "string",
"example": "UDP",
"description": "Protocols supported by the SIP provider. \n The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
},
"registration_expire_time": {
"type": "integer",
"default": 60,
"example": 60,
"maximum": 127,
"minimum": 1,
"description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
}
}
}
TrackingFieldCreateFieldRequest
{
"type": "object",
"title": "Tracking Field",
"properties": {
"field": {
"type": "string",
"example": "field1",
"description": "Label/ Name for the tracking field."
},
"visible": {
"type": "boolean",
"example": true,
"description": "Tracking Field Visible"
},
"required": {
"type": "boolean",
"example": false,
"description": "Tracking Field Required"
},
"recommended_values": {
"type": "array",
"items": {
"type": "string",
"example": "value1"
},
"description": "Array of recommended values"
}
},
"description": "Tracking Field"
}
TrackingFieldCreateFieldResponse
{
"type": "object",
"title": "Tracking Field",
"properties": {
"id": {
"type": "string",
"example": "a32CJji-weJ92",
"description": "Tracking Field ID"
},
"field": {
"type": "string",
"example": "field1",
"description": "Label/ Name for the tracking field."
},
"visible": {
"type": "boolean",
"example": true,
"description": "Tracking Field Visible"
},
"required": {
"type": "boolean",
"example": false,
"description": "Tracking Field Required"
},
"recommended_values": {
"type": "array",
"items": {
"type": "string",
"example": "value1"
},
"description": "Array of recommended values"
}
},
"description": "Tracking Field"
}
TrackingFieldGetResponse
{
"type": "object",
"title": "Tracking Field",
"properties": {
"id": {
"type": "string",
"example": "a32CJji-weJ92",
"description": "Tracking Field ID"
},
"field": {
"type": "string",
"example": "field1",
"description": "Label/ Name for the tracking field."
},
"visible": {
"type": "boolean",
"example": true,
"description": "Tracking Field Visible"
},
"required": {
"type": "boolean",
"example": false,
"description": "Tracking Field Required"
},
"recommended_values": {
"type": "array",
"items": {
"type": "string",
"example": "value1"
},
"description": "Array of recommended values"
}
},
"description": "Tracking Field"
}
TrackingFieldListResponse
{
"type": "object",
"properties": {
"total_records": {
"type": "integer",
"example": 1,
"description": "The number of all records available across pages"
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"title": "Tracking Field",
"properties": {
"id": {
"type": "string",
"example": "a32CJji-weJ92",
"description": "ID of Tracking Field"
},
"field": {
"type": "string",
"example": "field1",
"description": "Label/ Name for the tracking field."
},
"visible": {
"type": "boolean",
"example": true,
"description": "Tracking Field Visible"
},
"required": {
"type": "boolean",
"example": false,
"description": "Tracking Field Required"
},
"recommended_values": {
"type": "array",
"items": {
"type": "string",
"example": "value1"
},
"description": "Array of recommended values"
}
},
"description": "Tracking Field"
},
"description": "Array of Tracking Fields"
}
},
"description": "Tracking Field List"
}
TrackingFieldUpdateRequest
{
"type": "object",
"title": "Tracking Field",
"properties": {
"field": {
"type": "string",
"example": "field1",
"description": "Label/ Name for the tracking field."
},
"visible": {
"type": "boolean",
"example": true,
"description": "Tracking Field Visible"
},
"required": {
"type": "boolean",
"example": false,
"description": "Tracking Field Required"
},
"recommended_values": {
"type": "array",
"items": {
"type": "string",
"example": "value1"
},
"description": "Array of recommended values"
}
},
"description": "Tracking Field"
}
TspAddUserTspAccountRequest
{
"type": "object",
"title": "TSP Accounts List",
"required": [
"conference_code",
"leader_pin"
],
"properties": {
"leader_pin": {
"type": "string",
"example": "US_TSP_TB",
"maxLength": 16,
"minLength": 1,
"description": "Leader PIN: numeric value, length is less than 16."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge"
},
"conference_code": {
"type": "string",
"example": "0125",
"maxLength": 16,
"minLength": 1,
"description": "Conference code: numeric value, length is less than 16."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"maxLength": 6,
"description": "Country code."
},
"type": {
"enum": [
"toll",
"tollfree",
"media_link"
],
"type": "string",
"example": "toll",
"extensions": {
"x-enum-descriptions": [
"Toll number <br/>",
"Toll free number <br/>",
"Media link phone number <br/>"
]
},
"description": "Dial-in number types: \n `toll` - Toll number. \n `tollfree` -Toll free number. \n \n`media_link` - Media link."
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"minLength": 1,
"description": "Dial-in number: length is less than 16."
},
"country_label": {
"type": "string",
"example": "America",
"maxLength": 10,
"description": "Country Label, if passed, will display in place of code."
}
}
},
"description": "List of dial in numbers."
}
},
"description": "List of TSP accounts."
}
TspAddUserTspAccountResponse
{
"type": "object",
"title": "TSP Accounts List",
"required": [
"conference_code",
"leader_pin"
],
"properties": {
"id": {
"type": "string",
"example": "1",
"description": "The ID of the TSP account."
},
"leader_pin": {
"type": "string",
"example": "US_TSP_TB",
"maxLength": 16,
"minLength": 1,
"description": "Leader PIN: numeric value, length is less than 16."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge"
},
"conference_code": {
"type": "string",
"example": "0125",
"maxLength": 16,
"minLength": 1,
"description": "Conference code: numeric value, length is less than 16."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"maxLength": 6,
"description": "Country code."
},
"type": {
"enum": [
"toll",
"tollfree",
"media_link"
],
"type": "string",
"example": "toll",
"extensions": {
"x-enum-descriptions": [
"Toll number <br/>",
"Toll free number <br/>",
"Media link phone number <br/>"
]
},
"description": "Dial-in number types: \n `toll` - Toll number. \n `tollfree` -Toll free number. \n \n`media_link` - Media link."
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"minLength": 1,
"description": "Dial-in number: length is less than 16."
},
"country_label": {
"type": "string",
"example": "America",
"maxLength": 10,
"description": "Country Label, if passed, will display in place of code."
}
}
},
"description": "List of dial in numbers."
}
},
"description": "List of TSP accounts."
}
TspGetAccountInfoResponse
{
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Enable Telephony Service Provider for account users."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge zone"
},
"tsp_enabled": {
"type": "boolean",
"example": true,
"description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features."
},
"tsp_provider": {
"type": "string",
"example": "someprovidername",
"description": "Telephony Service Provider."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"description": "Country Code"
},
"type": {
"type": "string",
"example": "toll",
"description": "Dial-in number type."
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"description": "Dial-in number, length is less than 16"
}
}
}
},
"dial_in_number_unrestricted": {
"type": "boolean",
"example": false,
"description": "Control restriction on account users adding a TSP number outside of account's dial in numbers."
},
"modify_credential_forbidden": {
"type": "boolean",
"example": true,
"description": "Control restriction on account users being able to modify their TSP credentials."
},
"master_account_setting_extended": {
"type": "boolean",
"example": true,
"description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account."
}
}
}
TspGetUserTspAccountResponse
{
"type": "object",
"title": "TSP Account",
"required": [
"conference_code",
"leader_pin"
],
"properties": {
"id": {
"type": "string",
"example": "1",
"description": "The TSP account ID."
},
"leader_pin": {
"type": "string",
"example": "11189898",
"maxLength": 16,
"minLength": 1,
"description": "Leader PIN: numeric value, length is less than 16."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge"
},
"conference_code": {
"type": "string",
"example": "0125",
"maxLength": 16,
"minLength": 1,
"description": "Conference code: numeric value, length is less than 16."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"maxLength": 6,
"description": "Country code."
},
"type": {
"enum": [
"toll",
"tollfree",
"media_link"
],
"type": "string",
"example": "toll",
"extensions": {
"x-enum-descriptions": [
"Toll number <br/>",
"Toll free number <br/>",
"Media link phone number <br/>"
]
},
"description": "Dial-in number types: \n `toll` - Toll number. \n `tollfree` -Toll free number. \n `media_link` - Media link phone number. This is used for PSTN integration instead of a paid bridge number."
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"minLength": 1,
"description": "Dial-in number: length is less than 16."
},
"country_label": {
"type": "string",
"example": "America",
"maxLength": 10,
"description": "Country Label, if passed, will display in place of code."
}
}
},
"description": "List of dial in numbers."
}
},
"description": "TSP account of the user."
}
TspListUserTspAccountsResponse
{
"type": "object",
"properties": {
"tsp_accounts": {
"type": "array",
"items": {
"type": "object",
"title": "TSP Accounts List",
"required": [
"conference_code",
"leader_pin"
],
"properties": {
"id": {
"enum": [
"1",
"2"
],
"type": "string",
"example": "1",
"description": "The TSP credential ID."
},
"leader_pin": {
"type": "string",
"example": "11189898",
"maxLength": 16,
"minLength": 1,
"description": "Leader PIN: numeric value, length is less than 16."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge\n"
},
"conference_code": {
"type": "string",
"example": "0125",
"maxLength": 16,
"minLength": 1,
"description": "Conference code: numeric value, length is less than 16."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"maxLength": 6,
"description": "Country code."
},
"type": {
"enum": [
"toll",
"tollfree",
"media_link"
],
"type": "string",
"example": "toll",
"extensions": {
"x-enum-descriptions": [
"Toll number <br/>",
"Toll free number <br/>",
"Media link phone number <br/>"
]
},
"description": "Dial-in number types: \n `toll` - Toll number. \n `tollfree` -Toll free number. \n \n`media_link` - Media link"
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"minLength": 1,
"description": "Dial-in number: length is less than 16."
},
"country_label": {
"type": "string",
"example": "America",
"maxLength": 10,
"description": "Country Label, if passed, will display in place of code."
}
}
},
"description": "List of dial in numbers."
}
},
"description": "List of TSP accounts."
}
}
}
}
TspSetGlobalDialInUrlRequest
{
"type": "object",
"title": "TSP Global Dial-In URL Setting",
"properties": {
"audio_url": {
"type": "string",
"example": "https://example.com",
"maxLength": 512,
"description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters."
}
}
}
TspUpdateAccountTspInformationRequest
{
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Enable 3rd party audio conferencing for account users"
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge"
},
"tsp_enabled": {
"type": "boolean",
"example": true,
"description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features."
},
"tsp_provider": {
"type": "string",
"example": "someprovidername",
"description": "3rd party audio conferencing provider"
},
"dial_in_number_unrestricted": {
"type": "boolean",
"example": true,
"description": "Control restriction on account users adding a TSP number outside of account's dial in numbers."
},
"modify_credential_forbidden": {
"type": "boolean",
"example": true,
"description": "Control restriction on account users being able to modify their TSP credentials."
},
"master_account_setting_extended": {
"type": "boolean",
"example": true,
"description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account."
}
}
}
TspUpdateUserTspAccountRequest
{
"type": "object",
"title": "TSP Account",
"required": [
"conference_code",
"leader_pin"
],
"properties": {
"leader_pin": {
"type": "string",
"example": "11189898",
"maxLength": 16,
"minLength": 1,
"description": "Leader PIN: numeric value, length is less than 16."
},
"tsp_bridge": {
"enum": [
"US_TSP_TB",
"EU_TSP_TB"
],
"type": "string",
"example": "US_TSP_TB",
"description": "Telephony bridge"
},
"conference_code": {
"type": "string",
"example": "0125",
"maxLength": 16,
"minLength": 1,
"description": "Conference code: numeric value, length is less than 16."
},
"dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "1",
"maxLength": 6,
"description": "Country code."
},
"type": {
"enum": [
"toll",
"tollfree",
"media_link"
],
"type": "string",
"example": "toll",
"extensions": {
"x-enum-descriptions": [
"Toll number <br/>",
"Toll free number <br/>",
"Media link phone number <br/>"
]
},
"description": "Dial-in number types: \n `toll` - Toll number. \n `tollfree` -Toll free number. \n `media_link` - Media Link Phone Number. It is used for PSTN integration instead of paid bridge number."
},
"number": {
"type": "string",
"example": "+1 1000200200",
"maxLength": 16,
"minLength": 1,
"description": "Dial-in number: length is less than 16."
},
"country_label": {
"type": "string",
"example": "America",
"maxLength": 10,
"description": "Country Label, if passed, will display in place of code."
}
}
},
"description": "List of dial in numbers."
}
},
"description": "TSP account."
}
WebinarsAddPanelistsRequest
{
"type": "object",
"properties": {
"panelists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The panelist's full name.\n\n**Note:** This value cannot exceed more than 12 Chinese characters."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Panelist's email. See the [email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
},
"name_tag_id": {
"type": "string",
"example": "xHhPyb8ERMCmiC5njPjFdQ",
"description": "The name tag ID to bind."
},
"name_tag_name": {
"type": "string",
"example": "xHhPyb8ERMCmiC5njPjFdQ",
"description": "The panelist's name to display in the name tag."
},
"name_tag_pronouns": {
"type": "string",
"example": "pronouns",
"description": "The pronouns to display in the name tag."
},
"name_tag_description": {
"type": "string",
"example": "description",
"description": "The description for the name tag, such the person's title."
},
"virtual_background_id": {
"type": "string",
"example": "xHhPyb8ERMCmiC5njPjFdQ",
"description": "The virtual background ID to bind."
}
},
"description": "Panelist base object."
},
"maximum": 30,
"description": "List of panelist objects."
}
},
"description": "Webinar panelist."
}
WebinarsAddPanelistsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "95204914252",
"description": "Webinar Id."
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T07:30:16Z",
"description": "The time when the panelist was added."
}
}
}
WebinarsAddRegistrantRequest
{
"type": "object",
"required": [
"email",
"first_name"
],
"properties": {
"org": {
"type": "string",
"example": "Cooking Org",
"description": "The registrant's organization."
},
"zip": {
"type": "string",
"example": "94045",
"description": "The registrant's ZIP or postal code."
},
"city": {
"type": "string",
"example": "Mountain View",
"description": "The registrant's city."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"maxLength": 128,
"description": "The registrant's email address."
},
"phone": {
"type": "string",
"example": "5550100",
"description": "The registrant's phone number."
},
"state": {
"type": "string",
"example": "CA",
"description": "The registrant's state or province."
},
"address": {
"type": "string",
"example": "1800 Amphibious Blvd.",
"description": "The registrant's address."
},
"country": {
"type": "string",
"example": "US",
"description": "The registrant's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
},
"comments": {
"type": "string",
"example": "Looking forward to the discussion.",
"description": "The registrant's questions and comments."
},
"industry": {
"type": "string",
"example": "Food",
"description": "The registrant's industry."
},
"language": {
"enum": [
"en-US",
"de-DE",
"es-ES",
"fr-FR",
"jp-JP",
"pt-PT",
"ru-RU",
"zh-CN",
"zh-TW",
"ko-KO",
"it-IT",
"vi-VN",
"pl-PL",
"Tr-TR"
],
"type": "string",
"example": "en-US",
"description": "The registrant's language preference for confirmation emails: \n* `en-US` - English (US) \n* `de-DE` - German (Germany) \n* `es-ES` - Spanish (Spain) \n* `fr-FR` - French (France) \n* `jp-JP` - Japanese \n* `pt-PT` - Portuguese (Portugal) \n* `ru-RU` - Russian \n* `zh-CN` - Chinese (PRC) \n* `zh-TW` - Chinese (Taiwan) \n* `ko-KO` - Korean \n* `it-IT` - Italian (Italy) \n* `vi-VN` - Vietnamese \n* `pl-PL` - Polish \n* `Tr-TR` - Turkish"
},
"job_title": {
"type": "string",
"example": "Chef",
"description": "The registrant's job title."
},
"last_name": {
"type": "string",
"example": "Chill",
"maxLength": 64,
"description": "The registrant's last name."
},
"source_id": {
"type": "string",
"example": "4816766181770",
"description": "The tracking source's unique identifier."
},
"first_name": {
"type": "string",
"example": "Jill",
"maxLength": 64,
"description": "The registrant's first name."
},
"no_of_employees": {
"enum": [
"",
"1-20",
"21-50",
"51-100",
"101-500",
"500-1,000",
"1,001-5,000",
"5,001-10,000",
"More than 10,000"
],
"type": "string",
"example": "1-20",
"description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-500` \n* `500-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
},
"custom_questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "What do you hope to learn from this?",
"description": "The custom question's title."
},
"value": {
"type": "string",
"example": "Look forward to learning how you come up with new recipes and what other services you offer.",
"maxLength": 128,
"description": "The custom question's response value. This has a limit of 128 characters."
}
},
"description": "Information about custom questions."
},
"description": "Information about custom questions."
},
"purchasing_time_frame": {
"enum": [
"",
"Within a month",
"1-3 months",
"4-6 months",
"More than 6 months",
"No timeframe"
],
"type": "string",
"example": "1-3 months",
"description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
},
"role_in_purchase_process": {
"enum": [
"",
"Decision Maker",
"Evaluator/Recommender",
"Influencer",
"Not involved"
],
"type": "string",
"example": "Influencer",
"description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
}
},
"description": "Information about the webinar registrant."
}
WebinarsAddRegistrantResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 92674392836,
"description": "The webinar's ID."
},
"topic": {
"type": "string",
"example": "My Webinar",
"maxLength": 200,
"description": "The webinar's topic."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/22222",
"description": "The URL the registrant can use to join the webinar."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2021-07-13T21:44:51Z",
"description": "The webinar's start time."
},
"occurrences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "available",
"description": "Occurrence status."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Duration."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-25T07:46:00Z",
"description": "Start time."
},
"occurrence_id": {
"type": "string",
"example": "1648194360000",
"description": "Occurrence ID: Unique identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences."
}
},
"description": "Occurrence object. This object is only returned for recurring webinars."
},
"description": "Array of occurrence objects."
},
"registrant_id": {
"type": "string",
"example": "fdgsfh2ey82fuh",
"description": "The registrant's ID."
}
}
}
WebinarsCreateBatchRegistrantsRequest
{
"type": "object",
"properties": {
"registrants": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"first_name"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The registrant's email address."
},
"last_name": {
"type": "string",
"example": "Chill",
"description": "The registrant's last name."
},
"first_name": {
"type": "string",
"example": "Jill",
"description": "The registrant's first name."
}
}
}
},
"auto_approve": {
"type": "boolean",
"example": true,
"description": "If a meeting was scheduled with approval_type `1` (manual approval), but you want to automatically approve registrants added via this API, set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting that was originally scheduled with approval_type `0` (automatic approval)."
}
}
}
WebinarsCreateBatchRegistrantsResponse
{
"type": "object",
"properties": {
"registrants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "jchill@example.com",
"description": "The registrant's email address."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "Unique URL using which registrant can join the webinar."
},
"registrant_id": {
"type": "string",
"example": "-rOym-zdTHOdbT3A7u7u5g",
"description": "The registrant's unique identifier."
}
}
}
}
}
}
WebinarsCreateBrandingNameTagRequest
{
"type": "object",
"required": [
"accent_color",
"background_color",
"name",
"text_color"
],
"properties": {
"name": {
"type": "string",
"example": "name",
"description": "The name tag's name.\n\n**Note:** This value cannot exceed more than 50 characters."
},
"is_default": {
"type": "boolean",
"default": false,
"example": true,
"description": "Whether set the name tag as the default name tag or not."
},
"text_color": {
"type": "string",
"format": "Hex color code",
"example": "0e72ed",
"description": "The name tag's text color."
},
"accent_color": {
"type": "string",
"format": "Hex color code",
"example": "0e72ed",
"description": "The name tag's accent color."
},
"background_color": {
"type": "string",
"format": "Hex color code",
"example": "0e72ed",
"description": "The name tag's background color."
},
"set_default_for_all_panelists": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether to set the name tag as the new default for all panelists or not. This includes panelists not currently assigned a default name tag."
}
},
"description": "Name tag information"
}
WebinarsCreateBrandingNameTagResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "J0sFXN2PSOCGrqTqLRwgAQ",
"description": "The name tag's ID."
},
"name": {
"type": "string",
"example": "name",
"description": "The name tag's name."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Whether the name tag is the default name tag or not."
},
"text_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's text color."
},
"accent_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's accent color."
},
"background_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's background_color color."
}
}
}
WebinarsCreateInviteLinksRequest
{
"type": "object",
"title": "Invite links",
"properties": {
"ttl": {
"type": "integer",
"format": "int64",
"default": 7200,
"example": 1000,
"maximum": 7776000,
"minimum": 0,
"description": "The invite link's expiration time, in seconds. \n\nThis value defaults to `7200`."
},
"attendees": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"maxLength": 64,
"description": "User display name."
}
}
},
"maxItems": 500,
"minItems": 1,
"description": "The attendees list."
}
},
"description": "Invite Links"
}
WebinarsCreateInviteLinksResponse
{
"type": "object",
"title": "Invite Links",
"properties": {
"attendees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The user's display name."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "The URL to join the meeting."
}
}
},
"description": "The attendee list."
}
},
"description": "Invite links response."
}
WebinarsCreatePollRequest
{
"type": "object",
"title": "Meeting and webinar polling object.",
"properties": {
"title": {
"type": "string",
"example": "Learn something new",
"maxLength": 64,
"description": "The poll's title, up to 64 characters."
},
"anonymous": {
"type": "boolean",
"default": false,
"example": true,
"description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
},
"poll_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 2,
"description": "The type of poll. \n* `1` - Poll. \n* `2` - Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` - Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this meeting?",
"maxLength": 255,
"description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
},
"type": {
"enum": [
"single",
"multiple",
"matching",
"rank_order",
"short_answer",
"long_answer",
"fill_in_the_blank",
"rating_scale"
],
"type": "string",
"example": "single",
"extensions": {
"x-enum-descriptions": [
"Single choice",
"Multiple choice",
"Matching",
"Rank order",
"Short answer",
"Long answer",
"Fill in the blank",
"Rating scale"
]
},
"description": "The poll's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order. \n* `short_answer` - Short answer. \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank. \n* `rating_scale` - Rating scale."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Extremely useful"
},
"minItems": 2,
"description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
},
"prompts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt_question": {
"type": "string",
"example": "How are you?",
"description": "The question prompt's title."
},
"prompt_right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
}
}
},
"description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
},
"right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"minItems": 1,
"description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
},
"case_sensitive": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` - The answer is case-sensitive. \n* `false` - The answer is not case-sensitive. \n\nThis value defaults to `false`."
},
"answer_required": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
},
"rating_max_label": {
"type": "string",
"example": "Extremely Likely",
"description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_max_value": {
"type": "integer",
"example": 4,
"maximum": 10,
"description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_label": {
"type": "string",
"example": "Not likely",
"description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_value": {
"type": "integer",
"example": 0,
"minimum": 0,
"description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
},
"show_as_dropdown": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\nThis value defaults to `false`."
},
"answer_max_character": {
"type": "integer",
"example": 200,
"description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
},
"answer_min_character": {
"type": "integer",
"example": 1,
"minimum": 1,
"description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
}
}
},
"description": "Information about the poll's questions."
}
},
"description": "Information about meeting and webinar polling."
}
WebinarsCreatePollResponse
{
"type": "object",
"title": "Meeting and webinar polling object.",
"properties": {
"id": {
"type": "string",
"example": "QalIoKWLTJehBJ8e1xRrbQ",
"description": "Webinar Poll ID"
},
"title": {
"type": "string",
"example": "Learn something new",
"maxLength": 64,
"description": "The poll's title, up to 64 characters."
},
"status": {
"enum": [
"notstart",
"started",
"ended",
"sharing"
],
"type": "string",
"example": "notstart",
"extensions": {
"x-enum-descriptions": [
"Poll not start",
"Poll started",
"Poll ended",
"Poll is sharing"
]
},
"description": "Status of the Webinar Poll: \n `notstart` - Poll not started \n `started` - Poll started \n `ended` - Poll ended \n `sharing` - Sharing poll results"
},
"anonymous": {
"type": "boolean",
"default": false,
"example": true,
"description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
},
"poll_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 2,
"description": "The type of poll. \n* `1` - Poll. \n* `2` - Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` - Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this meeting?",
"maxLength": 255,
"description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
},
"type": {
"enum": [
"single",
"multiple",
"matching",
"rank_order",
"short_answer",
"long_answer",
"fill_in_the_blank",
"rating_scale"
],
"type": "string",
"example": "single",
"extensions": {
"x-enum-descriptions": [
"Single choice",
"Multiple choice",
"Matching",
"Rank order",
"Short answer",
"Long answer",
"Fill in the blank",
"Rating scale"
]
},
"description": "The poll's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order. \n* `short_answer` - Short answer. \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank. \n* `rating_scale` - Rating scale."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Extremely useful"
},
"minItems": 2,
"description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
},
"prompts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt_question": {
"type": "string",
"example": "How are you?",
"description": "The question prompt's title."
},
"prompt_right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
}
}
},
"description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
},
"right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"minItems": 1,
"description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
},
"case_sensitive": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` - The answer is case-sensitive. \n* `false` - The answer is not case-sensitive. \n\nThis value defaults to `false`."
},
"answer_required": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
},
"rating_max_label": {
"type": "string",
"example": "Extremely Likely",
"description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_max_value": {
"type": "integer",
"example": 4,
"maximum": 10,
"description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_label": {
"type": "string",
"example": "Not likely",
"description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_value": {
"type": "integer",
"example": 0,
"minimum": 0,
"description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
},
"show_as_dropdown": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\nThis value defaults to `false`."
},
"answer_max_character": {
"type": "integer",
"example": 200,
"description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
},
"answer_min_character": {
"type": "integer",
"example": 1,
"minimum": 1,
"description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
}
}
},
"description": "Information about the poll's questions."
}
},
"description": "Information about meeting and webinar polling."
}
WebinarsCreateWebinarRequest
{
"type": "object",
"properties": {
"type": {
"enum": [
5,
6,
9
],
"type": "integer",
"default": 5,
"example": 5,
"extensions": {
"x-enum-descriptions": [
"Webinar",
"Recurring webinar with no fixed time",
"Recurring webinar with fixed time"
]
},
"description": "Webinar types.\n `5` - Webinar. \n `6` - Recurring webinar with no fixed time. \n `9` - Recurring webinar with a fixed time."
},
"topic": {
"type": "string",
"example": "My Webinar",
"description": "Webinar topic."
},
"agenda": {
"type": "string",
"example": "My Webinar",
"description": "Webinar description."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Webinar duration in minutes. Used for scheduled webinars only."
},
"password": {
"type": "string",
"example": "123456",
"description": "Webinar passcode. Passcode may only contain the characters [a-z A-Z 0-9 @ - _ * !]. Maximum of 10 characters.\n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request. \n \n\n**Note:** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. \n \n If the requirements are enabled, you can view those requirements by calling the [**Get account settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/ma#operation/accountSettings) API."
},
"settings": {
"type": "object",
"properties": {
"audio": {
"enum": [
"both",
"telephony",
"voip",
"thirdParty"
],
"type": "string",
"default": "both",
"example": "telephony",
"extensions": {
"x-enum-descriptions": [
"Both Telephony and VoIP",
"Telephony only",
"VoIP only",
"Third party audio conference"
]
},
"description": "Determine how participants can join the audio portion of the meeting.(Not supported for simulive webinar.)"
},
"hd_video": {
"type": "boolean",
"default": false,
"example": false,
"description": "Default to HD video.(Not supported for simulive webinar.)"
},
"on_demand": {
"type": "boolean",
"default": false,
"example": false,
"description": "Make the webinar on-demand. Not supported for simulive webinar."
},
"host_video": {
"type": "boolean",
"example": true,
"description": "Start video when host joins webinar.(Not supported for simulive webinar.)"
},
"survey_url": {
"type": "string",
"example": "https://example.com",
"description": "Survey URL for post webinar survey"
},
"contact_name": {
"type": "string",
"example": "Jill Chill",
"description": "Contact name for registration"
},
"add_watermark": {
"type": "boolean",
"example": true,
"description": "Add watermark that identifies the viewing participant. Not supported for simulive webinar."
},
"approval_type": {
"enum": [
0,
1,
2
],
"type": "integer",
"default": 2,
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Automatically Approve",
"Manually Approve",
"No Registration Required"
]
},
"description": "The default value is `2`. To enable registration required, set the approval type to `0` or `1`. Values include: \n \n\n`0` - Automatically approve. \n `1` - Manually approve. \n `2` - No registration required."
},
"contact_email": {
"type": "string",
"example": "jchill@example.com",
"description": "Contact email for registration"
},
"enforce_login": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Only signed-in users can join this meeting. \n\n**This field is deprecated and will not be supported in future.** \n \n Instead of this field, use the `meeting_authentication`, `authentication_option`, or `authentication_domains` fields to establish the authentication mechanism for this Webinar. "
},
"auto_recording": {
"enum": [
"local",
"cloud",
"none"
],
"type": "string",
"default": "none",
"example": "cloud",
"extensions": {
"x-enum-descriptions": [
"Record to local device",
"Record to cloud",
"No Recording"
]
},
"description": "Automatic recording. Not supported for simulive webinar. \n `local` - Record on local. \n `cloud` - Record on cloud. \n `none` - Disabled."
},
"email_language": {
"type": "string",
"example": "en-US",
"description": "Set the email language.\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`id-ID`,`jp-JP`,`nl-NL`,`pl-PL`,`pt-PT`,`ru-RU`,`tr-TR`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
},
"panelists_video": {
"type": "boolean",
"example": true,
"description": "Start video when panelists join webinar. Not supported for simulive webinar."
},
"practice_session": {
"type": "boolean",
"default": false,
"example": false,
"description": "Enable practice session."
},
"alternative_hosts": {
"type": "string",
"example": "jchill@example.com;thill@example.com",
"description": "Alternative host emails or IDs. Multiple values separated by comma."
},
"registration_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"default": 1,
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Attendees register once and can attend any of the occurrences",
"Attendees need to register for each occurrence to attend",
"Attendees register once and can choose one or more occurrences to attend"
]
},
"description": "Registration types. Only used for recurring webinars with a fixed time. \n `1` - Attendees register once and can attend any of the webinar sessions. \n `2` - Attendees need to register for each session in order to attend. \n `3` - Attendees register once and can choose one or more sessions to attend."
},
"show_share_button": {
"type": "boolean",
"example": true,
"description": "Show social share buttons on the registration page."
},
"close_registration": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Close registration after event date."
},
"add_audio_watermark": {
"type": "boolean",
"example": true,
"description": "Add audio watermark that identifies the participants. Not supported for simulive webinar."
},
"post_webinar_survey": {
"type": "boolean",
"example": true,
"description": "Zoom will open a survey page in attendees' browsers after leaving the webinar"
},
"question_and_answer": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Enable [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false` - Disable Q&A for webinar."
},
"auto_reply_text": {
"type": "string",
"example": "Thank you for your question. We will get back to you shortly.",
"description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
},
"allow_auto_reply": {
"type": "boolean",
"example": true,
"description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
},
"answer_questions": {
"enum": [
"only",
"all"
],
"type": "string",
"example": "all",
"description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n* `all` - Attendees are able to view all questions submitted in the Q&A."
},
"attendees_can_upvote": {
"type": "boolean",
"example": true,
"description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.\n\n* `false` - Attendees can not click the thumbs up button on questions."
},
"attendees_can_comment": {
"type": "boolean",
"example": true,
"description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can not answer questions or leave a comment in the question thread"
},
"allow_submit_questions": {
"type": "boolean",
"example": true,
"description": "* `true`: Allow participants to submit questions.\n\n* `false`: Do not allow submit questions."
},
"allow_anonymous_questions": {
"type": "boolean",
"example": true,
"description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false` - Do not allow anonymous questions.(Not supported for simulive webinar.)"
}
},
"description": "[Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
},
"audio_conference_info": {
"type": "string",
"example": "test",
"maxLength": 2048,
"description": "Third party audio conference info."
},
"authentication_option": {
"type": "string",
"example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"description": "Specify the authentication type for users to join a Webinar with`meeting_authentication` setting set to `true`. The value of this field can be retrieved from the `id` field within `authentication_options` array in the response of [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API."
},
"enforce_login_domains": {
"type": "string",
"example": "example.com",
"deprecated": true,
"description": "Only signed-in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in future.** \n \n Instead of this field, use the `authentication_domains` field for this webinar. "
},
"allow_multiple_devices": {
"type": "boolean",
"example": true,
"description": "Allow attendees to join from multiple devices."
},
"authentication_domains": {
"type": "string",
"example": "example.com",
"description": "Meeting authentication domains. This option allows you to specify the rule so that Zoom users whose email address contains a certain domain can join the webinar. You can either provide multiple comma-separated domains, use a wildcard for listing domains, or use both methods."
},
"hd_video_for_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether HD video for attendees is enabled. This value defaults to `false`.(Not supported for simulive webinar.)"
},
"meeting_authentication": {
"type": "boolean",
"example": true,
"description": "Only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join meeting if the value of this field is set to `true`."
},
"enable_session_branding": {
"type": "boolean",
"example": true,
"description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts set Virtual Background and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
},
"language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"languages": {
"type": "string",
"example": "US,CN",
"description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
}
}
},
"description": "Information about the webinar's language interpreters."
}
},
"description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar. This is not supported for simulive webinars."
},
"panelist_authentication": {
"type": "boolean",
"example": true,
"description": "Require panelists to authenticate to join"
},
"global_dial_in_countries": {
"type": "array",
"items": {
"type": "string",
"example": "US"
},
"description": "List of global dial-in countries"
},
"registrants_restrict_number": {
"type": "integer",
"default": 0,
"example": 100,
"maximum": 20000,
"minimum": 0,
"description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
},
"sign_language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"sign_language": {
"type": "string",
"example": "American",
"description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."
}
}
},
"maximum": 20,
"description": "Information about the webinar's sign language interpreters."
}
},
"description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
},
"alternative_host_update_polls": {
"type": "boolean",
"example": true,
"description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
},
"send_1080p_video_to_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to always send 1080p video to attendees. This value defaults to `false`.(Not supported for simulive webinar.)"
},
"registrants_email_notification": {
"type": "boolean",
"example": true,
"description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
},
"follow_up_absentees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 days after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 days after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
}
},
"description": "Send follow-up email to absentees."
},
"follow_up_attendees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 day after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 day after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Send follow-up email to attendees.\n\n* `false`: Do not send follow-up email to attendees."
}
},
"description": "Send follow-up email to attendees."
},
"panelists_invitation_email_notification": {
"type": "boolean",
"example": true,
"description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
},
"attendees_and_panelists_reminder_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 hour before webinar.",
"Send 1 day before webinar.",
"Send 1 hour and 1 day before webinar.",
"Send 1 week before webinar.",
"Send 1 hour and 1 week before webinar.",
"Send 1 day and 1 week before webinar.",
"Send 1 hour, 1 day and 1 week before webinar."
]
},
"description": "`0` - No plan. \n `1` - Send 1 hour before webinar. \n `2` - Send 1 day before webinar. \n `3` - Send 1 hour and 1 day before webinar. \n `4` - Send 1 week before webinar. \n `5` - Send 1 hour and 1 week before webinar. \n `6` - Send 1 day and 1 week before webinar. \n `7` - Send 1 hour, 1 day and 1 week before webinar."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Send reminder email to attendees and panelists.\n\n* `false`: Do not send reminder email to attendees and panelists."
}
},
"description": "Send reminder email to attendees and panelists."
}
},
"description": "Create webinar settings."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring webinars with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
},
"recurrence": {
"type": "object",
"title": "Recurrence webinar",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Daily",
"Weekly",
"Monthly"
]
},
"description": "Recurrence webinar types.\n `1` - Daily. \n `2` - Weekly. \n `3` - Monthly."
},
"end_times": {
"type": "integer",
"default": 1,
"example": 7,
"maximum": 60,
"description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
},
"monthly_day": {
"type": "integer",
"example": 1,
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
},
"weekly_days": {
"type": "string",
"example": "1",
"description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat.\nThe value for this field could be a number between `1` to `7` in string format. For instance, if the webinar should recur on Sunday, provide `1` as the value of this field. \n \n **Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the webinar should recur on Sundays and Tuesdays, provide `1,3` as the value of this field.\n\n \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday.\n\n"
},
"monthly_week": {
"enum": [
-1,
1,
2,
3,
4
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Last week",
"First week",
"Second week",
"Third week",
"Fourth week"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the webinar should recur.** \n `-1` - Last week of the month. \n `1` - First week of the month. \n `2` - Second week of the month. \n `3` - Third week of the month. \n `4` - Fourth week of the month."
},
"end_date_time": {
"type": "string",
"format": "date-time",
"example": "2022-04-02T15:59:00Z",
"description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with `end_times`."
},
"repeat_interval": {
"type": "integer",
"example": 1,
"description": "Define the interval when the webinar should recur. For instance, if you would like to schedule a Webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
},
"monthly_week_day": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field. \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday."
}
},
"description": "Recurrence object. Use this object only for a webinar of type `9`, a recurring webinar with fixed time. "
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T06:44:14Z",
"description": "Webinar start time. We support two formats for `start_time` - local time and GMT. \n \n\nTo set time as GMT the format should be `yyyy-MM-dd`T`HH:mm:ssZ`.\n\nTo set time using a specific timezone, use `yyyy-MM-dd`T`HH:mm:ss` format and specify the timezone [ID](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones) in the `timezone` field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field.\n\nThe `start_time` should only be used for scheduled and / or recurring webinars with fixed time."
},
"is_simulive": {
"type": "boolean",
"example": true,
"description": "Whether to set the webinar simulive."
},
"template_id": {
"type": "string",
"example": "5Cj3ceXoStO6TGOVvIOVPA==",
"description": "The webinar template ID to schedule a webinar using a [webinar template](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates) or a [admin webinar template](https://support.zoom.us/hc/en-us/articles/8137753618957-Configuring-admin-webinar-templates). For a list of webinar templates, use the [**List webinar templates**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/listWebinarTemplates) API."
},
"schedule_for": {
"type": "string",
"example": "jchill@example.com",
"description": "The email address or user ID of the user to schedule a webinar for."
},
"record_file_id": {
"type": "string",
"example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
"description": "The previously recorded file's ID for `simulive`."
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"type": "string",
"example": "field1",
"description": "Tracking fields type."
},
"value": {
"type": "string",
"example": "value1",
"description": "Tracking fields value."
}
}
},
"description": "Tracking fields."
}
},
"description": "Webinar object."
}
WebinarsCreateWebinarResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 95204914252,
"description": "Webinar ID in **long** format, represented as int64 data type in JSON. Also known as the webinar number."
},
"type": {
"enum": [
5,
6,
9
],
"type": "integer",
"default": 5,
"example": 5,
"extensions": {
"x-enum-descriptions": [
"Webinar",
"Recurring Webinar with no fixed time",
"Recurring Webinar with fixed time"
]
},
"description": "Webinar Types: \n `5` - Webinar. \n `6` - Recurring webinar with no fixed time. \n `9` - Recurring webinar with a fixed time."
},
"uuid": {
"type": "string",
"example": "Bznyg8KZTdCVbQxvS/oZ7w==",
"description": "Unique identifier of a webinar. Each webinar instance will generate its own UUID. Ror example, after a webinar ends, a new UUID will be generated for the next instance of the Webinar). Once a Webinar ends, the value of the UUID for the same webinar will be different from when it was scheduled."
},
"topic": {
"type": "string",
"example": "My Webinar",
"maxLength": 200,
"description": "Webinar topic."
},
"agenda": {
"type": "string",
"example": "My Webinar",
"description": "Webinar agenda."
},
"host_id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "ID of the user set as host of the webinar."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Webinar duration."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "URL to join the webinar. Only share this URL with the users who should be invited to the Webinar."
},
"password": {
"type": "string",
"example": "123456",
"maxLength": 10,
"description": "Webinar passcode. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request. \n \n \n**Note:** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. \n \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/ma#operation/accountSettings) API."
},
"settings": {
"type": "object",
"properties": {
"audio": {
"enum": [
"both",
"telephony",
"voip",
"thirdParty"
],
"type": "string",
"default": "both",
"example": "telephony",
"extensions": {
"x-enum-descriptions": [
"Both Telephony and VoIP",
"Telephony only",
"VoIP only",
"Third party audio conference"
]
},
"description": "Determine how participants can join the audio portion of the webinar."
},
"hd_video": {
"type": "boolean",
"default": false,
"example": false,
"description": "Default to HD video."
},
"on_demand": {
"type": "boolean",
"default": false,
"example": false,
"description": "Make the webinar on-demand"
},
"host_video": {
"type": "boolean",
"example": true,
"description": "Start video when host joins webinar."
},
"survey_url": {
"type": "string",
"example": "https://example.com",
"description": "Survey url for post webinar survey"
},
"contact_name": {
"type": "string",
"example": "Jill Chill",
"description": "Contact name for registration"
},
"add_watermark": {
"type": "boolean",
"example": true,
"description": "Add watermark that identifies the viewing participant."
},
"approval_type": {
"enum": [
0,
1,
2
],
"type": "integer",
"default": 2,
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Automatically Approve",
"Manually Approve",
"No Registration Required"
]
},
"description": "`0` - Automatically approve. \n `1` - Manually approve. \n `2` - No registration required."
},
"contact_email": {
"type": "string",
"example": "jchill@example.com",
"description": "Contact email for registration"
},
"enforce_login": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**\n\n As an alternative, use the `meeting_authentication`, `authentication_option` and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the webinar."
},
"auto_recording": {
"enum": [
"local",
"cloud",
"none"
],
"type": "string",
"default": "none",
"example": "cloud",
"extensions": {
"x-enum-descriptions": [
"Record to local device",
"Record to cloud",
"No Recording"
]
},
"description": "Automatic recording. \n `local` - Record on local. \n `cloud` - Record on cloud. \n `none` - Disabled."
},
"email_language": {
"type": "string",
"example": "en-US",
"description": "Set the email language to one of the following:\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
},
"panelists_video": {
"type": "boolean",
"example": true,
"description": "Start video when panelists join webinar."
},
"practice_session": {
"type": "boolean",
"default": false,
"example": false,
"description": "Enable practice session."
},
"alternative_hosts": {
"type": "string",
"example": "jchill@example.com",
"description": "Alternative host emails or IDs. Multiple values separated by comma."
},
"registration_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"default": 1,
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Attendees register once and can attend any of the occurrences",
"Attendees need to register for each occurrence to attend",
"Attendees register once and can choose one or more occurrences to attend"
]
},
"description": "Registration types. Only used for recurring webinars with a fixed time. \n `1` - Attendees register once and can attend any of the webinar sessions. \n `2` - Attendees need to register for each session in order to attend. \n `3` - Attendees register once and can choose one or more sessions to attend."
},
"show_share_button": {
"type": "boolean",
"example": true,
"description": "Show social share buttons on the registration page."
},
"close_registration": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Close registration after event date."
},
"notify_registrants": {
"type": "boolean",
"example": true,
"description": "Send notification email to registrants when the host updates a webinar."
},
"add_audio_watermark": {
"type": "boolean",
"example": true,
"description": "Add audio watermark that identifies the participants."
},
"authentication_name": {
"type": "string",
"example": "Sign in to Zoom",
"description": "Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f)."
},
"post_webinar_survey": {
"type": "boolean",
"example": true,
"description": "Zoom will open a survey page in attendees' browsers after leaving the webinar"
},
"question_and_answer": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Enable [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false`: Disable Q&A for webinar."
},
"auto_reply_text": {
"type": "string",
"example": "Thank you for your question. We will get back to you shortly.",
"description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
},
"allow_auto_reply": {
"type": "boolean",
"example": true,
"description": "If simulive webinar, \n\n* `true`: allow auto-reply to attendees. \n\n* `false`: don't allow auto-reply to the attendees."
},
"answer_questions": {
"enum": [
"only",
"all"
],
"type": "string",
"example": "all",
"description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only`: Attendees are able to view answered questions only.\n\n* `all`: Attendees are able to view all questions submitted in the Q&A."
},
"attendees_can_upvote": {
"type": "boolean",
"example": true,
"description": "* `true`: Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.\n\n* `false`: Attendees can not click the thumbs up button on questions."
},
"attendees_can_comment": {
"type": "boolean",
"example": true,
"description": "* `true`: Attendees can answer questions or leave a comment in the question thread.\n\n* `false`: Attendees can not answer questions or leave a comment in the question thread"
},
"allow_submit_questions": {
"type": "boolean",
"example": true,
"description": "* `true`: Allow participants to submit questions.\n\n* `false`: Do not allow submit questions."
},
"allow_anonymous_questions": {
"type": "boolean",
"example": true,
"description": "* `true`: Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false`: Do not allow anonymous questions."
}
},
"description": "[Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
},
"audio_conference_info": {
"type": "string",
"example": "test",
"maxLength": 2048,
"description": "Third party audio conference info."
},
"authentication_option": {
"type": "string",
"example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"description": "Webinar authentication option ID."
},
"enforce_login_domains": {
"type": "string",
"example": "example.com",
"deprecated": true,
"description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**\n\n As an alternative, use the `meeting_authentication`, `authentication_option` and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the webinar."
},
"allow_multiple_devices": {
"type": "boolean",
"example": true,
"description": "Allow attendees to join from multiple devices."
},
"authentication_domains": {
"type": "string",
"example": "example.com",
"description": "If user has configured [**Sign Into Zoom with Specified Domains**](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated."
},
"hd_video_for_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether HD video for attendees is enabled."
},
"meeting_authentication": {
"type": "boolean",
"example": true,
"description": "Only authenticated users can join Webinar."
},
"enable_session_branding": {
"type": "boolean",
"example": true,
"description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [Webinar Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
},
"language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"languages": {
"type": "string",
"example": "US,CN",
"description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
}
}
},
"description": "Information about the webinar's language interpreters."
}
},
"description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
},
"panelist_authentication": {
"type": "boolean",
"example": true,
"description": "Require panelists to authenticate to join"
},
"global_dial_in_countries": {
"type": "array",
"items": {
"type": "string",
"example": "US"
},
"description": "List of global dial-in countries"
},
"registrants_restrict_number": {
"type": "integer",
"default": 0,
"example": 100,
"maximum": 20000,
"minimum": 0,
"description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
},
"sign_language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"sign_language": {
"type": "string",
"example": "American",
"description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."
}
}
},
"maximum": 20,
"description": "Information about the webinar's sign language interpreters."
}
},
"description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
},
"alternative_host_update_polls": {
"type": "boolean",
"example": true,
"description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
},
"send_1080p_video_to_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Always send 1080p video to attendees."
},
"registrants_confirmation_email": {
"type": "boolean",
"example": true,
"description": "Send confirmation email to registrants"
},
"registrants_email_notification": {
"type": "boolean",
"example": true,
"description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
},
"follow_up_absentees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 days after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 days after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Send follow-up email to absentees.\n\n* `false`: Do not send follow-up email to absentees."
}
},
"description": "Send follow-up email to absentees."
},
"follow_up_attendees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 day after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 day after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Send follow-up email to attendees.\n\n* `false`: Do not send follow-up email to attendees."
}
},
"description": "Send follow-up email to attendees."
},
"panelists_invitation_email_notification": {
"type": "boolean",
"example": true,
"description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
},
"attendees_and_panelists_reminder_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 hour before webinar.",
"Send 1 day before webinar.",
"Send 1 hour and 1 day before webinar.",
"Send 1 week before webinar.",
"Send 1 hour and 1 week before webinar.",
"Send 1 day and 1 week before webinar.",
"Send 1 hour, 1 day and 1 week before webinar."
]
},
"description": "`0` - No plan. \n `1` - Send 1 hour before webinar. \n `2` - Send 1 day before webinar. \n `3` - Send 1 hour and 1 day before webinar. \n `4` - Send 1 week before webinar. \n `5` - Send 1 hour and 1 week before webinar. \n `6` - Send 1 day and 1 week before webinar. \n `7` - Send 1 hour, 1 day and 1 week before webinar."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
}
},
"description": "Send reminder email to attendees and panelists."
}
},
"description": "Webinar settings."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "Time zone to format start_time."
},
"start_url": {
"type": "string",
"example": "https://example.com/s/11111",
"description": " \n The `start_url` of a webinar is a URL using which a host or an alternative host can start the webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the webinar. \n\nThe expiration time for the `start_url` field listed in the response of the [**Create a webinar**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/webinarCreate) API is two hours for all regular users. \n\t\nFor users created using the `custCreate` option via the [**Create users**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userCreate) API, the expiration time of the `start_url` field is 90 days.\n\t\nFor security reasons, to retrieve the latest value for the `start_url` field programmatically after expiry, call the [**Get a webinar**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/webinar) API and refer to the value of the `start_url` field in the response. \n \n \n "
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T07:18:32Z",
"description": "Create time."
},
"host_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Email address of the meeting host."
},
"recurrence": {
"type": "object",
"title": "Recurrence webinar",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Daily",
"Weekly",
"Monthly"
]
},
"description": "Recurrence webinar types. \n `1` - Daily. \n `2` - Weekly. \n `3` - Monthly."
},
"end_times": {
"type": "integer",
"default": 1,
"example": 7,
"maximum": 60,
"description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Can't be used with `end_date_time`."
},
"monthly_day": {
"type": "integer",
"example": 1,
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
},
"weekly_days": {
"type": "string",
"example": "1",
"description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat. \n The value for this field could be a number between `1` to `7` in string format. For instance, if the Webinar should recur on Sunday, provide `1` as the value of this field.\n\n**Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the webinar should recur on Sundays and Tuesdays, provide `1,3` as the value of this field.\n\n \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday.\n\n"
},
"monthly_week": {
"enum": [
-1,
1,
2,
3,
4
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Last week",
"First week",
"Second week",
"Third week",
"Fourth week"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the webinar should recur.** \n `-1` - Last week of the month. \n `1` - First week of the month. \n `2` - Second week of the month. \n `3` - Third week of the month. \n `4` - Fourth week of the month."
},
"end_date_time": {
"type": "string",
"format": "date-time",
"example": "2022-04-02T15:59:00Z",
"description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Can't be used with `end_times`."
},
"repeat_interval": {
"type": "integer",
"example": 1,
"description": "Define the interval when the webinar should recur. For instance, if you would like to schedule a Webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
},
"monthly_week_day": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field. \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday."
}
},
"description": "Recurrence object. Use this object only for a webinar of type `9` i.e., a recurring webinar with fixed time. "
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T07:18:32Z",
"description": "Webinar start time in GMT/UTC."
},
"is_simulive": {
"type": "boolean",
"example": true,
"description": "Whether the webinar is `simulive`."
},
"occurrences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"available",
"deleted"
],
"type": "string",
"example": "available",
"description": "Occurrence status. \n `available` - Available occurrence. \n `deleted` - Deleted occurrence."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Duration."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-25T07:46:00Z",
"description": "Start time."
},
"occurrence_id": {
"type": "string",
"example": "1648194360000",
"description": "Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences."
}
},
"description": "Occurrence object. This object is only returned for recurring webinars."
},
"description": "Array of occurrence objects."
},
"template_id": {
"type": "string",
"example": "ull6574eur",
"description": "Unique identifier of the webinar template. Use this field only if you would like to [schedule the webinar using an existing template](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates#schedule). The value of this field can be retrieved from [**List webinar templates**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/listWebinarTemplates) API.\nYou must provide the user ID of the host instead of the email address in the `userId` path parameter in order to use a template for scheduling a Webinar."
},
"h323_passcode": {
"type": "string",
"example": "123456",
"description": "H.323/SIP room system passcode."
},
"record_file_id": {
"type": "string",
"example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
"description": "The previously recorded file's ID for `simulive`."
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "field1",
"description": "Tracking fields type"
},
"value": {
"type": "string",
"example": "value1",
"description": "Tracking fields value"
}
}
},
"description": "Tracking fields"
},
"encrypted_passcode": {
"type": "string",
"example": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
"description": "Encrypted passcode for third party endpoints (H323/SIP)."
},
"registrants_confirmation_email": {
"type": "boolean",
"example": true,
"description": "Specify whether or not registrants of this webinar should receive confirmation emails."
}
},
"description": "Webinar object."
}
WebinarsCreateWebinarTemplateRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Weekly Meeting Template",
"description": "The webinar template's name."
},
"overwrite": {
"type": "boolean",
"default": false,
"example": false,
"description": "Overwrite an existing webinar template if the template is created from same existing webinar."
},
"webinar_id": {
"type": "integer",
"format": "int64",
"example": 96172769962,
"description": "The webinar ID in long (int64) format."
},
"save_recurrence": {
"type": "boolean",
"default": false,
"example": false,
"description": "If the field is set to true, the recurrence webinar template will be saved as the scheduled webinar."
}
}
}
WebinarsCreateWebinarTemplateResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ull6574eur",
"description": "The webinar template's ID."
},
"name": {
"type": "string",
"example": "Weekly Meeting Template",
"description": "The webinar template's name."
}
}
}
WebinarsGetDetailsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 97871060099,
"description": "Webinar ID in **long** format(represented as int64 data type in JSON), also known as the webinar number."
},
"type": {
"enum": [
5,
6,
9
],
"type": "integer",
"default": 5,
"example": 5,
"extensions": {
"x-enum-descriptions": [
"Webinar",
"Recurring Webinar with no fixed time",
"Recurring Webinar with fixed time"
]
},
"description": "Webinar types. \n `5` - Webinar. \n `6` - Recurring webinar with no fixed time. \n `9` - Recurring webinar with a fixed time."
},
"uuid": {
"type": "string",
"example": "m3WqMkvuRXyYqH+eKWhk9w==",
"description": "Unique webinar ID. Each webinar instance will generate its own webinar UUID. After a webinar ends, a new UUID is generated for the next instance of the webinar. Retrieve a list of UUIDs from past webinar instances using the [**List past webinar instances**](https://developers.zoom.us) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n\n"
},
"topic": {
"type": "string",
"example": "My Webinar",
"maxLength": 200,
"description": "Webinar topic."
},
"agenda": {
"type": "string",
"example": "My webinar",
"description": "Webinar agenda."
},
"host_id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "ID of the user set as host of webinar."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Webinar duration."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "URL to join the webinar. Only share this URL with the users who should be invited to the webinar."
},
"password": {
"type": "string",
"example": "123456",
"maxLength": 10,
"description": "Webinar passcode. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request. \n \n \n**Note:** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. \n \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](https://developers.zoom.us) API or the [**Get account settings**](https://developers.zoom.us) API."
},
"settings": {
"type": "object",
"properties": {
"audio": {
"enum": [
"both",
"telephony",
"voip",
"thirdParty"
],
"type": "string",
"default": "both",
"example": "telephony",
"extensions": {
"x-enum-descriptions": [
"Both Telephony and VoIP",
"Telephony only",
"VoIP only",
"Third party audio conference"
]
},
"description": "Determine how participants can join the audio portion of the webinar."
},
"hd_video": {
"type": "boolean",
"default": false,
"example": false,
"description": "Default to HD video."
},
"on_demand": {
"type": "boolean",
"default": false,
"example": false,
"description": "Make the webinar on-demand."
},
"host_video": {
"type": "boolean",
"example": true,
"description": "Start video when host joins webinar."
},
"survey_url": {
"type": "string",
"example": "https://example.com",
"description": "Survey URL for post webinar survey."
},
"contact_name": {
"type": "string",
"example": "Jill Chill",
"description": "Contact name for registration."
},
"add_watermark": {
"type": "boolean",
"example": true,
"description": "Add watermark that identifies the viewing participant."
},
"approval_type": {
"enum": [
0,
1,
2
],
"type": "integer",
"default": 2,
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Automatically Approve",
"Manually Approve",
"No Registration Required"
]
},
"description": "`0` - Automatically approve. \n `1` - Manually approve. \n `2` - No registration required."
},
"contact_email": {
"type": "string",
"example": "jchill@example.com",
"description": "Contact email for registration."
},
"enforce_login": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.** \n\n As an alternative, use the `meeting_authentication`, `authentication_option` and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the Webinar."
},
"auto_recording": {
"enum": [
"local",
"cloud",
"none"
],
"type": "string",
"default": "none",
"example": "cloud",
"extensions": {
"x-enum-descriptions": [
"Record to local device",
"Record to cloud",
"No Recording"
]
},
"description": "Automatic recording. \n `local` - Record on local. \n `cloud` - Record on cloud. \n `none` - Disabled."
},
"email_language": {
"type": "string",
"example": "en-US",
"description": "Set the email language. The only options are\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
},
"panelists_video": {
"type": "boolean",
"example": true,
"description": "Start video when panelists join webinar."
},
"practice_session": {
"type": "boolean",
"default": false,
"example": false,
"description": "Enable practice session."
},
"alternative_hosts": {
"type": "string",
"example": "jchill@example.com",
"description": "Alternative host emails or IDs. Multiple values separated by comma."
},
"registration_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"default": 1,
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Attendees register once and can attend any of the occurrences",
"Attendees need to register for each occurrence to attend",
"Attendees register once and can choose one or more occurrences to attend"
]
},
"description": "Registration types. Only used for recurring webinars with a fixed time. \n `1` - Attendees register once and can attend any of the webinar sessions. \n `2` - Attendees need to register for each session in order to attend. \n `3` - Attendees register once and can choose one or more sessions to attend."
},
"show_share_button": {
"type": "boolean",
"example": true,
"description": "Show social share buttons on the registration page."
},
"close_registration": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Close registration after event date."
},
"notify_registrants": {
"type": "boolean",
"example": true,
"description": "Send notification email to registrants when the host updates a webinar."
},
"add_audio_watermark": {
"type": "boolean",
"example": true,
"description": "Add audio watermark that identifies the participants."
},
"authentication_name": {
"type": "string",
"example": "Sign in to Zoom",
"description": "Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f)."
},
"post_webinar_survey": {
"type": "boolean",
"example": true,
"description": "Zoom will open a survey page in attendees' browsers after leaving the webinar."
},
"question_and_answer": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "* `true`: Enable [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false`: Disable Q&A for webinar."
},
"auto_reply_text": {
"type": "string",
"example": "Thank you for your question. We will get back to you shortly.",
"description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
},
"allow_auto_reply": {
"type": "boolean",
"example": true,
"description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
},
"answer_questions": {
"enum": [
"only",
"all"
],
"type": "string",
"example": "all",
"description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n* `all` - Attendees are able to view all questions submitted in the Q&A."
},
"attendees_can_upvote": {
"type": "boolean",
"example": true,
"description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.\n\n* `false` - Attendees can not click the thumbs up button on questions."
},
"attendees_can_comment": {
"type": "boolean",
"example": true,
"description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can not answer questions or leave a comment in the question thread"
},
"allow_submit_questions": {
"type": "boolean",
"example": true,
"description": "* `true` - Allow participants to submit questions.\n\n* `false` - Do not allow submit questions."
},
"allow_anonymous_questions": {
"type": "boolean",
"example": true,
"description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists.\n\n* `false` - Do not allow anonymous questions."
}
},
"description": "[Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
},
"audio_conference_info": {
"type": "string",
"example": "test",
"maxLength": 2048,
"description": "Third party audio conference info."
},
"authentication_option": {
"type": "string",
"example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"description": "Webinar authentication option id."
},
"enforce_login_domains": {
"type": "string",
"example": "example.com",
"deprecated": true,
"description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.** \n\n As an alternative, use the `meeting_authentication`, `authentication_option`, and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the Webinar."
},
"allow_multiple_devices": {
"type": "boolean",
"example": true,
"description": "Allow attendees to join from multiple devices."
},
"authentication_domains": {
"type": "string",
"example": "example.com",
"description": "If user has configured [**Sign Into Zoom with Specified Domains**](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated."
},
"hd_video_for_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether HD video for attendees is enabled."
},
"meeting_authentication": {
"type": "boolean",
"example": true,
"description": "Only authenticated users can join the webinar."
},
"enable_session_branding": {
"type": "boolean",
"example": true,
"description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [webinar session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
},
"language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"languages": {
"type": "string",
"example": "US,CN",
"description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
}
}
},
"description": "Information about the webinar's language interpreters."
}
},
"description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
},
"panelist_authentication": {
"type": "boolean",
"example": true,
"description": "Require panelists to authenticate to join."
},
"global_dial_in_countries": {
"type": "array",
"items": {
"type": "string",
"example": "US"
},
"description": "List of global dial-in countries"
},
"registrants_restrict_number": {
"type": "integer",
"default": 0,
"example": 100,
"maximum": 20000,
"minimum": 0,
"description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
},
"sign_language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the webinar."
},
"interpreters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "interpreter@example.com",
"description": "The interpreter's email address."
},
"sign_language": {
"type": "string",
"example": "American",
"description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
}
}
},
"maximum": 20,
"description": "Information about the webinar's sign language interpreters."
}
},
"description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
},
"alternative_host_update_polls": {
"type": "boolean",
"example": true,
"description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
},
"send_1080p_video_to_attendees": {
"type": "boolean",
"default": false,
"example": false,
"description": "Always send 1080p video to attendees."
},
"registrants_confirmation_email": {
"type": "boolean",
"example": true,
"description": "Send confirmation email to registrants"
},
"registrants_email_notification": {
"type": "boolean",
"example": true,
"description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
},
"follow_up_absentees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 days after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 days after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
}
},
"description": "Send follow-up email to absentees."
},
"follow_up_attendees_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 day after the scheduled end date.",
"Send 2 days after the scheduled end date.",
"Send 3 days after the scheduled end date.",
"Send 4 days after the scheduled end date.",
"Send 5 days after the scheduled end date.",
"Send 6 days after the scheduled end date.",
"Send 7 days after the scheduled end date."
]
},
"description": "`0` - No plan. \n `1` - Send 1 day after the scheduled end date. \n `2` - Send 2 days after the scheduled end date. \n `3` - Send 3 days after the scheduled end date. \n `4` - Send 4 days after the scheduled end date. \n `5` - Send 5 days after the scheduled end date. \n `6` - Send 6 days after the scheduled end date. \n `7` - Send 7 days after the scheduled end date."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Send follow-up email to attendees.\n\n* `false` - Do not send follow-up email to attendees."
}
},
"description": "Send follow-up email to attendees."
},
"panelists_invitation_email_notification": {
"type": "boolean",
"example": true,
"description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
},
"attendees_and_panelists_reminder_email_notification": {
"type": "object",
"properties": {
"type": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Send 1 hour before webinar.",
"Send 1 day before webinar.",
"Send 1 hour and 1 day before webinar.",
"Send 1 week before webinar.",
"Send 1 hour and 1 week before webinar.",
"Send 1 day and 1 week before webinar.",
"Send 1 hour, 1 day and 1 week before webinar."
]
},
"description": "`0` - No plan. \n `1` - Send 1 hour before webinar. \n `2` - Send 1 day before webinar. \n `3` - Send 1 hour and 1 day before webinar. \n `4` - Send 1 week before webinar. \n `5` - Send 1 hour and 1 week before webinar. \n `6` - Send 1 day and 1 week before webinar. \n `7` - Send 1 hour, 1 day and 1 week before webinar."
},
"enable": {
"type": "boolean",
"example": true,
"description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
}
},
"description": "Send reminder email to attendees and panelists."
}
},
"description": "Webinar settings."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "Time zone to format `start_time`."
},
"start_url": {
"type": "string",
"example": "https://example.com/s/11111",
"description": " \n The `start_url` of a webinar is a URL using which a host or an alternative host can start the webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the webinar. \n\nThe expiration time for the `start_url` field listed in the response of the [**Create a webinar**](https://developers.zoom.us) API is two hours for all regular users. \n\t\nFor users created using the `custCreate` option via the [**Create users**](https://developers.zoom.us) API, the expiration time of the `start_url` field is 90 days.\n\t\nFor security reasons, to retrieve the latest value for the `start_url` field programmatically (after expiry), you must call the [**Get a webinar**](https://developers.zoom.us) API and refer to the value of the `start_url` field in the response.\n\n\n "
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T07:18:32Z",
"description": "Create time."
},
"host_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Email address of the meeting host."
},
"recurrence": {
"type": "object",
"title": "Recurrence webinar",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Daily",
"Weekly",
"Monthly"
]
},
"description": "Recurrence webinar types. \n `1` - Daily. \n `2` - Weekly. \n `3` - Monthly."
},
"end_times": {
"type": "integer",
"default": 1,
"example": 7,
"maximum": 60,
"description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
},
"monthly_day": {
"type": "integer",
"example": 1,
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month, the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
},
"weekly_days": {
"type": "string",
"example": "1",
"description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat. \n The value for this field could be a number between `1` to `7` in string format. For instance, if the Webinar should recur on Sunday, provide `1` as the value of this field. \n \n **Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the Webinar should recur on Sundays and Tuesdays provide `1,3` as the value of this field.\n\n \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday.\n\n"
},
"monthly_week": {
"enum": [
-1,
1,
2,
3,
4
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Last week",
"First week",
"Second week",
"Third week",
"Fourth week"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the webinar should recur.** \n `-1` - Last week of the month. \n `1` - First week of the month. \n `2` - Second week of the month. \n `3` - Third week of the month. \n `4` - Fourth week of the month."
},
"end_date_time": {
"type": "string",
"format": "date-time",
"example": "2022-04-02T15:59:00Z",
"description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with `end_times`.)"
},
"repeat_interval": {
"type": "integer",
"example": 1,
"description": "Define the interval when the webinar should recur. For instance, to schedule a webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
},
"monthly_week_day": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field. \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday."
}
},
"description": "Recurrence object. Use this object only for a webinar of type `9` i.e., a recurring webinar with fixed time. "
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T07:18:32Z",
"description": "Webinar start time in GMT/UTC."
},
"is_simulive": {
"type": "boolean",
"example": true,
"description": "Whether the webinar is `simulive`."
},
"occurrences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"available",
"deleted"
],
"type": "string",
"example": "available",
"description": "Occurrence status: \n `available` - Available occurrence. \n `deleted` - Deleted occurrence."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Duration."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-25T07:46:00Z",
"description": "Start time."
},
"occurrence_id": {
"type": "string",
"example": "1648194360000",
"description": "Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences."
}
},
"description": "Occurrence object. This object is only returned for recurring webinars."
},
"description": "Array of occurrence objects."
},
"h323_passcode": {
"type": "string",
"example": "123456",
"description": "H.323/SIP room system passcode."
},
"record_file_id": {
"type": "string",
"example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
"description": "The previously recorded file's ID for `simulive`."
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "field1",
"description": "Tracking fields type."
},
"value": {
"type": "string",
"example": "value1",
"description": "Tracking fields value."
}
}
},
"description": "Tracking fields."
},
"encrypted_passcode": {
"type": "string",
"example": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
"description": "Encrypted passcode for third party endpoints (H323/SIP)."
}
},
"description": "Webinar object."
}
WebinarsGetJoinTokenLocalRecordingResponse
{
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "2njt50mj",
"description": "The join token."
},
"expire_in": {
"enum": [
120
],
"type": "integer",
"format": "int64",
"example": 120,
"description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
}
},
"description": "Information about the webinar's local recorder join token."
}
WebinarsGetLiveStreamDetailsResponse
{
"type": "object",
"properties": {
"page_url": {
"type": "string",
"example": "https://example.com/livestream/123",
"description": "Live streaming page URL. This is the URL using which anyone can view the live stream of the webinar."
},
"resolution": {
"type": "string",
"example": "720p",
"description": "The number of pixels in each dimension that the video camera can display."
},
"stream_key": {
"type": "string",
"example": "contact-it@example.com",
"description": "Stream key."
},
"stream_url": {
"type": "string",
"example": "https://example.com/livestream",
"description": "Stream URL."
}
}
}
WebinarsGetMeetingArchiveTokenForLocalArchivingResponse
{
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "2njt50mj",
"description": "The archive token."
},
"expire_in": {
"enum": [
120
],
"type": "integer",
"format": "int64",
"example": 120,
"description": "The number of seconds the archive token is valid for before it expires. This value always returns `120`."
}
},
"description": "Information about the webinar's local archive token."
}
WebinarsGetPollDetailsResponse
{
"type": "object",
"title": "Meeting and Webinar Polling Object",
"properties": {
"id": {
"type": "string",
"example": "QalIoKWLTJehBJ8e1xRrbQ",
"description": "Webinar Poll ID"
},
"title": {
"type": "string",
"example": "Learn something new",
"maxLength": 64,
"description": "The poll's title, up to 64 characters."
},
"status": {
"enum": [
"notstart",
"started",
"ended",
"sharing"
],
"type": "string",
"example": "notstart",
"extensions": {
"x-enum-descriptions": [
"Poll not start",
"Poll started",
"Poll ended",
"Poll is sharing"
]
},
"description": "Status of the Webinar Poll: \n `notstart` - Poll not started \n `started` - Poll started \n `ended` - Poll ended \n `sharing` - Sharing poll results"
},
"anonymous": {
"type": "boolean",
"default": false,
"example": true,
"description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
},
"poll_type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 2,
"description": "The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this meeting?",
"maxLength": 255,
"description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
},
"type": {
"enum": [
"single",
"multiple",
"matching",
"rank_order",
"short_answer",
"long_answer",
"fill_in_the_blank",
"rating_scale"
],
"type": "string",
"example": "single",
"extensions": {
"x-enum-descriptions": [
"Single choice",
"Multiple choice",
"Matching",
"Rank order",
"Short answer",
"Long answer",
"Fill in the blank",
"Rating scale"
]
},
"description": "The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Extremely useful"
},
"minItems": 2,
"description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
},
"prompts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt_question": {
"type": "string",
"example": "How are you?",
"description": "The question prompt's title."
},
"prompt_right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
}
}
},
"description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
},
"right_answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"minItems": 1,
"description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
},
"case_sensitive": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`."
},
"answer_required": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
},
"rating_max_label": {
"type": "string",
"example": "Extremely Likely",
"description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_max_value": {
"type": "integer",
"example": 4,
"maximum": 10,
"description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_label": {
"type": "string",
"example": "Not likely",
"description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
},
"rating_min_value": {
"type": "integer",
"example": 0,
"minimum": 0,
"description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
},
"show_as_dropdown": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`."
},
"answer_max_character": {
"type": "integer",
"example": 200,
"description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
},
"answer_min_character": {
"type": "integer",
"example": 1,
"minimum": 1,
"description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
}
}
},
"description": "Information about the poll's questions."
}
},
"description": "Information about meeting and webinar polling."
}
WebinarsGetSessionBrandingResponse
{
"type": "object",
"properties": {
"name_tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zazQjwDuQkS3Q2EprNd7jQ",
"description": "The name tag's ID."
},
"name": {
"type": "string",
"example": "name",
"description": "The name tag's name."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Whether the file is the default name tag or not."
},
"text_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's text color."
},
"accent_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's accent color."
},
"background_color": {
"type": "string",
"example": "0e72ed",
"description": "The name tag's background color."
}
}
},
"description": "Information about the webinar's name tag."
},
"wallpaper": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zazQjwDuQkS3Q2EprNd7jQ",
"description": "The wallpaper's file ID."
}
},
"description": "Information about the webinar's [Wallpaper] file."
},
"virtual_backgrounds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zazQjwDuQkS3Q2EprNd7jQ",
"description": "The Virtual Background's file ID."
},
"name": {
"type": "string",
"example": "beach.jpg",
"description": "The Virtual Background's file name."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Whether the file is the default Virtual Background file."
}
}
},
"description": "Information about the webinar's [Virtual Background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) files."
}
},
"description": "Information about the webinar's sessions branding."
}
WebinarsGetSipUriWithPasscodeRequest
{
"type": "object",
"properties": {
"passcode": {
"type": "string",
"example": "xxxx",
"description": "If customers want a passcode to be embedded in the SIP URI dial string, they must supply the passcode. Zoom will not validate the passcode."
}
}
}
WebinarsGetSipUriWithPasscodeResponse
{
"type": "object",
"properties": {
"expire_in": {
"type": "integer",
"format": "int64",
"example": 7200,
"description": "The number of seconds the encoded SIP URI is valid before it expires."
},
"sip_dialing": {
"type": "string",
"example": "9678722567.xxxx....30qonrvgy@zoomcrc.com",
"description": "The webinar's encoded SIP URI."
},
"paid_crc_plan_participant": {
"type": "boolean",
"example": true,
"description": "Whether the API caller has a Conference Room Connector (CRC) plan."
},
"participant_identifier_code": {
"type": "string",
"example": "30qonrvgy",
"description": "This value identifies the webinar participant. It is automatically embedded in the SIP URI if the API caller has a CRC plan."
}
},
"description": "Information about the webinar's encoded SIP URI."
}
WebinarsGetSurveyResponse
{
"type": "object",
"title": "Webinar survey object",
"properties": {
"custom_survey": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Learn something new",
"maxLength": 64,
"description": "The survey's title, up to 64 characters."
},
"feedback": {
"type": "string",
"example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
"maxLength": 320,
"description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey, your feedback really makes a difference.`."
},
"anonymous": {
"type": "boolean",
"default": false,
"example": false,
"description": "Allow participants to anonymously answer survey questions. \n* `true` - Anonymous survey enabled. \n* `false` - Participants cannot answer survey questions anonymously. \n\n This value defaults to `true`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this webinar?",
"description": "The survey question, up to 420 characters."
},
"type": {
"enum": [
"single",
"multiple",
"matching",
"rank_order",
"short_answer",
"long_answer",
"fill_in_the_blank",
"rating_scale"
],
"type": "string",
"example": "single",
"extensions": {
"x-enum-descriptions": [
"Single choice",
"Multiple choice",
"Matching",
"Rank order",
"Short answer",
"Long answer",
"Fill in the blank",
"Rating scale"
]
},
"description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Extremely useful",
"maxLength": 200
},
"minItems": 2,
"description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
},
"prompts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prompt_question": {
"type": "string",
"example": "How are you?",
"maxLength": 200,
"description": "The question prompt's title."
}
}
},
"maxItems": 10,
"minItems": 2,
"description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
},
"answer_required": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
},
"rating_max_label": {
"type": "string",
"example": "Extremely Likely",
"maxLength": 50,
"description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
},
"rating_max_value": {
"type": "integer",
"example": 4,
"maximum": 10,
"description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
},
"rating_min_label": {
"type": "string",
"example": "Not likely",
"maxLength": 50,
"description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
},
"rating_min_value": {
"type": "integer",
"example": 1,
"minimum": 0,
"description": "The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey."
},
"show_as_dropdown": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
},
"answer_max_character": {
"type": "integer",
"example": 200,
"description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
},
"answer_min_character": {
"type": "integer",
"example": 1,
"minimum": 1,
"description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "Information about the webinar survey's questions."
},
"numbered_questions": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
},
"show_question_type": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
}
},
"description": "Information about the customized webinar survey."
},
"third_party_survey": {
"type": "string",
"example": "https://example.com",
"maxLength": 64,
"description": "The link to the third party webinar survey."
},
"show_in_the_browser": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether the **Show in the browser when the webinar ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
},
"show_in_the_follow_up_email": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the **Show the link on the follow-up email** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `false`."
}
},
"description": "Information about the webinar survey."
}
WebinarsGetWebinarTokenResponse
{
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "https://example.com/closedcaption?id=200610693&ns=GZHkEA==&expire=86400&spparams=id%2Cns%2Cexpire&signature=nYtXJqRKCW",
"description": "The generated webinar token."
}
},
"description": "Information about the webinar token."
}
WebinarsJoinTokenLiveStreamingResponse
{
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "2njt50mj",
"description": "The join token."
},
"expire_in": {
"enum": [
120
],
"type": "integer",
"format": "int64",
"example": 120,
"description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
}
},
"description": "Information about the webinar's join token."
}
WebinarsListAbsenteesResponse
{
"type": "object",
"title": "Registration List",
"properties": {
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The number of records returned with a single API call."
},
"page_count": {
"type": "integer",
"example": 1,
"description": "The number of pages returned for the request made."
},
"page_number": {
"type": "integer",
"default": 1,
"example": 1,
"deprecated": true,
"description": "**Deprecated.** This field is deprecated. We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
},
"registrants": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"first_name"
],
"properties": {
"id": {
"type": "string",
"example": "9tboDiHUQAeOnbmudzWa5g",
"description": "Registrant ID."
},
"org": {
"type": "string",
"example": "Cooking Org",
"description": "The registrant's organization."
},
"zip": {
"type": "string",
"example": "94045",
"description": "The registrant's ZIP or postal code."
},
"city": {
"type": "string",
"example": "Mountain View",
"description": "The registrant's city."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"maxLength": 128,
"description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
},
"phone": {
"type": "string",
"example": "5550100",
"description": "The registrant's phone number."
},
"state": {
"type": "string",
"example": "CA",
"description": "The registrant's state or province."
},
"status": {
"enum": [
"approved",
"denied",
"pending"
],
"type": "string",
"example": "approved",
"description": "The status of the registrant's registration.\n `approved` - User has been successfully approved for the webinar. \n `pending` - The registration is still pending. \n `denied` - User has been denied from joining the webinar."
},
"address": {
"type": "string",
"example": "1800 Amphibious Blvd.",
"description": "The registrant's address."
},
"country": {
"type": "string",
"example": "US",
"description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
},
"comments": {
"type": "string",
"example": "Looking forward to the discussion.",
"description": "The registrant's questions and comments."
},
"industry": {
"type": "string",
"example": "Food",
"description": "The registrant's industry."
},
"join_url": {
"type": "string",
"format": "string",
"example": "https://example.com/j/11111",
"description": "The URL that an approved registrant can use to join the meeting or webinar."
},
"job_title": {
"type": "string",
"example": "Chef",
"description": "The registrant's job title."
},
"last_name": {
"type": "string",
"example": "Chill",
"maxLength": 64,
"description": "The registrant's last name."
},
"first_name": {
"type": "string",
"example": "Jill",
"maxLength": 64,
"description": "The registrant's first name."
},
"create_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-22T05:59:09Z",
"description": "The time when the registrant registered."
},
"no_of_employees": {
"enum": [
"",
"1-20",
"21-50",
"51-100",
"101-250",
"251-500",
"501-1,000",
"1,001-5,000",
"5,001-10,000",
"More than 10,000"
],
"type": "string",
"example": "1-20",
"description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
},
"custom_questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "What do you hope to learn from this?",
"description": "The title of the custom question."
},
"value": {
"type": "string",
"example": "Look forward to learning how you come up with new recipes and what other services you offer.",
"maxLength": 128,
"description": "The custom question's response value. This has a limit of 128 characters."
}
},
"description": "Information about custom questions."
},
"description": "Information about custom questions."
},
"purchasing_time_frame": {
"enum": [
"",
"Within a month",
"1-3 months",
"4-6 months",
"More than 6 months",
"No timeframe"
],
"type": "string",
"example": "1-3 months",
"description": "The registrant's purchasing time frame. \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
},
"role_in_purchase_process": {
"enum": [
"",
"Decision Maker",
"Evaluator/Recommender",
"Influencer",
"Not involved"
],
"type": "string",
"example": "Influencer",
"description": "The registrant's role in the purchase process. \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
}
},
"description": " Registrant."
},
"description": "List of registrant objects."
},
"total_records": {
"type": "integer",
"example": 20,
"description": "The total number of all the records available across pages."
},
"next_page_token": {
"type": "string",
"example": "w7587w4eiyfsudgf",
"description": "Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
}
},
"description": "List of users."
}
WebinarsListPanelistsResponse
{
"type": "object",
"title": "Panelist List",
"properties": {
"panelists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Tg2b6GhcQKKbV7nSCbDKug",
"description": "Panelist's ID."
},
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The panelist's full name.\n\n**Note** This value cannot exceed more than 12 Chinese characters."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Panelist's email. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "Join URL."
},
"name_tag_id": {
"type": "string",
"example": "xHhPyb8ERMCmiC5njPjFdQ",
"description": "The name tag ID to bind."
},
"name_tag_name": {
"type": "string",
"example": "name",
"description": "The panelist's name to display in the name tag."
},
"name_tag_pronouns": {
"type": "string",
"example": "pronouns",
"description": "The pronouns to display in the name tag."
},
"name_tag_description": {
"type": "string",
"example": "description",
"description": "The description for the name tag, such as the person's title)."
},
"virtual_background_id": {
"type": "string",
"example": "xHhPyb8ERMCmiC5njPjFdQ",
"description": "The virtual background's ID."
}
},
"description": "Panelist base object."
},
"description": "List of panelist objects."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "Total records."
}
},
"description": "Webinar panelist."
}
WebinarsListParticipantsResponse
{
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The total number of records returned from a single API call."
},
"page_count": {
"type": "integer",
"example": 1,
"description": "The number of pages returned for this request."
},
"participants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "The participant's unique identifier."
},
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's name."
},
"status": {
"enum": [
"in_meeting",
"in_waiting_room"
],
"type": "string",
"example": "in_meeting",
"description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
},
"user_id": {
"type": "string",
"example": "ABCDEF123456",
"description": "The participant's ID. This ID is assigned to the participant upon joining the webinar and is only valid for that webinar."
},
"duration": {
"type": "integer",
"example": 20,
"description": "The participant's attendance duration."
},
"failover": {
"type": "boolean",
"example": false,
"description": "Whether failover occurred during the webinar."
},
"join_time": {
"type": "string",
"format": "date-time",
"example": "2019-02-01T12:34:12.660Z",
"description": "The participant's join time."
},
"leave_time": {
"type": "string",
"format": "date-time",
"example": "2019-02-01T12:54:12.660Z",
"description": "The participant's leave time."
},
"user_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Email address of the participant. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
},
"registrant_id": {
"type": "string",
"example": "_f08HhPJS82MIVLuuFaJPg",
"description": "The participant's unique registrant ID. This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter. \n\nThis field does not return if the `type` query parameter is the `live` value."
}
}
}
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The total number of records available across all pages."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"description": "Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
}
}
}
WebinarsListPastInstancesResponse
{
"type": "object",
"title": "Webinar instances",
"properties": {
"webinars": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"example": "Bznyg8KZTdCVbQxvS/oZ7w==",
"description": "Webinar UUID."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T06:44:14Z",
"description": "Start time."
}
}
},
"description": "List of ended webinar instances."
}
},
"description": "List of webinars."
}
WebinarsListPastWebinarQaResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 95204914252,
"description": "Webinar ID in **long** format, represented as int64 data type in JSON, also known as the webinar number."
},
"uuid": {
"type": "string",
"example": "Bznyg8KZTdCVbQxvS/oZ7w==",
"description": "Webinar UUID."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "Name of the user. If `anonymous` option is enabled for the Q&A, the participant's information will be kept anonymous and the value of `name` field will be `Anonymous Attendee`."
},
"email": {
"type": "string",
"example": "jchill@example.com",
"description": "Email address of the user. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
},
"question_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "Good",
"description": "Answer submitted for the question. The value will be 'live answered' if this is a live answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "Question asked during the Q&A."
}
}
}
}
}
}
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T06:44:14Z",
"description": "The webinar's start time."
}
}
}