MeetingsGetJoinTokenResponse
{
"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 meeting's join token."
}
MeetingsGetLivestreamDetailsResponse
{
"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 livestream of the meeting."
},
"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-ic@example.com",
"description": "Stream Key."
},
"stream_url": {
"type": "string",
"example": "https://example.com/livestream",
"description": "Stream URL."
}
}
}
MeetingsGetMeetingArchiveTokenForLocalArchivingResponse
{
"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 meeting's local archive token."
}
MeetingsGetMeetingSummaryResponse
{
"type": "object",
"properties": {
"meeting_id": {
"type": "integer",
"format": "int64",
"example": 97763643886,
"description": "[The meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) \nThe meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number."
},
"next_steps": {
"type": "array",
"items": {
"type": "string",
"example": "step1",
"description": "The next step."
},
"description": "The next steps."
},
"meeting_uuid": {
"type": "string",
"example": "aDYlohsHRtCd4ii1uC2+hA==",
"description": "The unique meeting ID. \n\nEach meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting.\n\n Use the [**List past meeting instances**](https://developers.zoom.us) API to retrieve a list of UUIDs from past meeting instances. [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"
},
"meeting_topic": {
"type": "string",
"example": "My Meeting",
"description": "The meeting topic."
},
"summary_title": {
"type": "string",
"example": "Meeting summary for my meeting",
"description": "The summary title."
},
"edited_summary": {
"type": "object",
"properties": {
"next_steps": {
"type": "array",
"items": {
"type": "string",
"example": "step1",
"description": "The user edited next step."
},
"description": "The user edited next steps."
},
"summary_details": {
"type": "string",
"example": "Meeting overview",
"description": "The user edited summary details."
}
}
},
"meeting_host_id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "The ID of the user who is set as the meeting host."
},
"summary_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"example": "Meeting overview",
"description": "The summary label."
},
"summary": {
"type": "string",
"example": "Meeting overview",
"description": "The summary content."
}
},
"description": "The summary detail object."
},
"description": "The summary content details."
},
"meeting_end_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The meeting's end date and time."
},
"summary_end_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The summary's end date and time."
},
"summary_overview": {
"type": "string",
"example": "Meeting overview",
"description": "The summary overview."
},
"meeting_host_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The meeting host's email address."
},
"meeting_start_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The meeting's start date and time."
},
"summary_start_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The summary's start date and time."
},
"summary_created_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The date and time when the meeting summary was created."
},
"summary_last_modified_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The date and time when the meeting summary was last modified."
}
}
}
MeetingsGetMeetingSurveyResponse
{
"type": "object",
"title": "Meeting 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\n This value defaults to `true`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this meeting?",
"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 meeting 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 meeting survey."
},
"third_party_survey": {
"type": "string",
"example": "https://example.com",
"maxLength": 64,
"description": "The link to the third party meeting survey."
},
"show_in_the_browser": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether the **Show in the browser when the meeting ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
}
},
"description": "Information about the meeting survey."
}
MeetingsGetMeetingTokenResponse
{
"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 meeting token."
}
},
"description": "Information about the meeting token."
}
MeetingsGetPastMeetingParticipantsResponse
{
"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": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "Universally unique identifier of the Participant. It is the same as the User ID of the participant if the participant joins the meeting by logging into Zoom. If the participant joins the meeting without logging in, the value of this field will be blank."
},
"name": {
"type": "string",
"example": "Jill Chill",
"description": "Participant display 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": "27423744",
"description": "Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only."
},
"duration": {
"type": "integer",
"example": 259,
"description": "Participant duration, in seconds, calculated by subtracting the `leave_time` from the `join_time` for the `user_id`. If the participant leaves and rejoins the same meeting, they will be assigned a different `user_id` and Zoom displays their new duration in a separate object. Note that because of this, the duration may not reflect the total time the user was in the meeting."
},
"failover": {
"type": "boolean",
"example": false,
"description": "Indicates if failover happened during the meeting."
},
"join_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T06:58:09Z",
"description": "Participant join time."
},
"leave_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T07:02:28Z",
"description": "Participant leave time."
},
"user_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."
},
"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."
}
}
},
"description": "Array of meeting participant objects."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The number of all records available across pages."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
},
"description": "Pagination object."
}
MeetingsGetPollResponse
{
"type": "object",
"title": "Meeting and Webinar Polling Object",
"properties": {
"id": {
"type": "string",
"example": "QalIoKWLTJehBJ8e1xRrbQ",
"description": "Meeting 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 Meeting 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."
}
MeetingsGetRegistrantDetailsResponse
{
"type": "object",
"title": "Meeting Registrant",
"required": [
"email",
"first_name"
],
"properties": {
"id": {
"type": "string",
"example": "9tboDiHUQAeOnbmudzWa5g"
},
"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 registrant's registration status.\n* `approved` - The registrant is approved to join the meeting. \n* `pending` - The registrant's registration is pending.\n* `denied` - The registrant was declined to join the meeting."
},
"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."
},
"join_url": {
"type": "string",
"format": "url",
"example": "https://example.com/j/11111",
"description": "The URL with which the approved registrant can join the meeting."
},
"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:58:44Z",
"description": "The registrant's registration date and time."
},
"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."
},
"participant_pin_code": {
"type": "integer",
"format": "int64",
"example": 380303,
"description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
},
"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."
}
MeetingsGetSipUriWithPasscodeRequest
{
"type": "object",
"properties": {
"passcode": {
"type": "string",
"example": "xxxx",
"description": "If customers desire that a passcode be embedded in the SIP URI dial string, they must supply the passcode. Zoom will not validate the passcode."
}
}
}
MeetingsGetSipUriWithPasscodeResponse
{
"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 meeting's encoded SIP URI."
},
"paid_crc_plan_participant": {
"type": "boolean",
"example": true,
"description": "Whether the API caller has a CRC (Conference Room Connector) plan."
},
"participant_identifier_code": {
"type": "string",
"example": "30qonrvgy",
"description": "This value identifies the meeting participant. It is automatically embedded in the SIP URI if the API caller has a CRC (Conference Room Connector) plan."
}
},
"description": "Information about the meeting's encoded SIP URI."
}
MeetingsListHostScheduledResponse
{
"type": "object",
"properties": {
"meetings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 97763643886,
"description": "Meeting ID - also known as the meeting number in long (int64) format."
},
"pmi": {
"type": "string",
"example": "97891943927",
"description": "[Personal meeting ID](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). This field is only returned if PMI was used to schedule the meeting."
},
"type": {
"enum": [
1,
2,
3,
8
],
"type": "integer",
"example": 2,
"extensions": {
"x-enum-descriptions": [
"Instant Meeting",
"Scheduled Meeting",
"Recurring Meeting with no fixed time",
"Recurring Meeting with fixed time"
]
},
"description": "Meeting types. \n `1` - Instant meeting. \n `2` - Scheduled meeting. \n `3` - Recurring meeting with no fixed time. \n `8` - Recurring meeting with fixed time."
},
"uuid": {
"type": "string",
"example": "aDYlohsHRtCd4ii1uC2+hA==",
"description": "Unique Meeting ID. Each meeting instance will generate its own Meeting UUID."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "Meeting topic."
},
"agenda": {
"type": "string",
"example": "My Meeting",
"description": "Meeting description. The length of agenda gets truncated to 250 characters when you list all of a user's meetings. To view a meeting's complete agenda, or to retrieve details for a single meeting, use the [**Get a meeting**](https://developers.zoom.us) API."
},
"host_id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "ID of the user who is set as the meeting's host."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Meeting duration."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "URL using which participants can join a meeting."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "Timezone to format the meeting start time. "
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T05:31:16Z",
"description": "Time of creation."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T06:00:00Z",
"description": "Meeting start time."
}
}
},
"description": "List of meeting objects."
},
"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,
"description": "The page number of the current results."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The total number of all the 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 will be returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
}
},
"description": "Pagination object."
}
MeetingsListMeetingPollsResponse
{
"type": "object",
"title": "Poll List",
"properties": {
"polls": {
"type": "array",
"items": {
"type": "object",
"title": "Meeting and Webinar Polling Object",
"properties": {
"id": {
"type": "string",
"example": "QalIoKWLTJehBJ8e1xRrbQ",
"description": "ID of Poll"
},
"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 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."
},
"description": "Array of Polls"
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The number of all records available across pages"
}
},
"description": "Poll List"
}
MeetingsListMeetingSummariesResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date-time",
"example": "2023-10-20T07:00:00Z",
"description": "The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format used to retrieve the creation date range of the meeting summaries."
},
"from": {
"type": "string",
"format": "date-time",
"example": "2023-10-19T07:00:00Z",
"description": "The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format used to retrieve the creation date range of the meeting summaries."
},
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The number of records returned with a single API call."
},
"summaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"meeting_id": {
"type": "integer",
"format": "int64",
"example": 97763643886,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON, also known as the meeting number."
},
"meeting_uuid": {
"type": "string",
"example": "aDYlohsHRtCd4ii1uC2+hA==",
"description": "Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting 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"
},
"meeting_topic": {
"type": "string",
"example": "My Meeting",
"description": "Meeting topic."
},
"meeting_host_id": {
"type": "string",
"example": "30R7kT7bTIKSNUFEuH_Qlg",
"description": "The ID of the user who is set as the meeting host."
},
"meeting_end_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The meeting's end date and time."
},
"summary_end_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The summary's end date and time."
},
"meeting_host_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The meeting host's email address."
},
"meeting_start_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The meeting's start date and time."
},
"summary_start_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The summary's start date and time."
},
"summary_created_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The date and time at which the meeting summary was created."
},
"summary_last_modified_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The date and time at which the meeting summary was last modified."
}
},
"description": "The meeting summary object."
},
"description": "List of meeting summary objects."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"description": "The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
}
}
MeetingsListMeetingTemplatesResponse
{
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "AdxbhxCzKgSiWAw",
"description": "The template ID."
},
"name": {
"type": "string",
"example": "My meeting template",
"description": "The template name."
},
"type": {
"type": "integer",
"example": 1,
"description": "The template type: \n \n`1`: Meeting template \n \n`2`: Admin meeting template"
}
}
}
},
"total_records": {
"type": "integer",
"example": 1,
"description": "Total records found for this request."
}
}
}
MeetingsListPastMeetingInstancesResponse
{
"type": "object",
"title": "Meeting instances",
"properties": {
"meetings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"example": "Vg8IdgluR5WDeWIkpJlElQ==",
"description": "Meeting UUID. Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). [Double encode](https://marketplace.zoom.us/docs/api-reference/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"
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T05:37:59Z",
"description": "Start time"
}
}
},
"description": "List of ended meeting instances."
}
},
"description": "List of Meetings"
}
MeetingsListPastMeetingPollsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 93398114182,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format(represented as int64 data type in JSON), also known as the meeting number."
},
"uuid": {
"type": "string",
"example": "Vg8IdgluR5WDeWIkpJlElQ==",
"description": "Meeting UUID."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "Name of the user who submitted answers to the poll. If `anonymous` option is enabled for a poll, the participant's polling 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 who submitted answers to the poll. If the user 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 by the user."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "Question asked during the poll."
},
"date_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T05:37:59Z",
"description": "Date and time at which the answer to the poll was submitted."
},
"polling_id": {
"type": "string",
"example": "QalIoKWLTJehBJ8e1xRrbQ",
"description": "Unique identifier of the poll."
}
}
}
}
}
}
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T05:37:59Z",
"description": "The start time of the meeting."
}
}
}
MeetingsListPastMeetingQaResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 95204914252,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format, represented as int64 data type in JSON, also known as the meeting number."
},
"uuid": {
"type": "string",
"example": "Bznyg8KZTdCVbQxvS/oZ7w==",
"description": "Meeting UUID."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The user's name. If `anonymous` option is enabled for the Q&A, the participant's information is be kept anonymous and the value of `name` field is `Anonymous Attendee`."
},
"email": {
"type": "string",
"example": "jchill@example.com",
"description": "The user's email address. If the user 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": "An answer submitted for the question. The value is 'live answered' if this is a live answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "A question asked during the Q&A."
}
}
}
}
}
}
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-26T06:44:14Z",
"description": "The meeting's start time."
}
}
}
MeetingsListRegistrantsResponse
{
"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.** 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 [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 using which an approved registrant can 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 at which 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."
},
"participant_pin_code": {
"type": "integer",
"format": "int64",
"example": 380303,
"description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
},
"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": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
},
"description": "List of users."
}
MeetingsListRegistrationQuestionsResponse
{
"type": "object",
"title": "Meeting Registrant Questions",
"properties": {
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"example": true,
"description": "Indicates whether or not the displayed fields are required to be filled out by registrants."
},
"field_name": {
"enum": [
"last_name",
"address",
"city",
"country",
"zip",
"state",
"phone",
"industry",
"org",
"job_title",
"purchasing_time_frame",
"role_in_purchase_process",
"no_of_employees",
"comments"
],
"type": "string",
"example": "last_name",
"description": "Field name of the question."
}
}
},
"description": "Array of Registrant Questions"
},
"custom_questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"short",
"single"
],
"type": "string",
"example": "short",
"extensions": {
"x-enum-descriptions": [
"Short Answer",
"Single Answer"
]
},
"description": "Type of the question being asked."
},
"title": {
"type": "string",
"example": "How are you?",
"description": "Title of the custom question."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"description": "Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer."
},
"required": {
"type": "boolean",
"example": true,
"description": "Indicates whether or not the custom question is required to be answered by participants or not."
}
}
},
"description": "Array of Registrant Custom Questions"
}
},
"description": "Meeting Registrant Questions"
}
MeetingsListUpcomingMeetingsResponse
{
"type": "object",
"properties": {
"meetings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 97763643886,
"description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - a unique identifier of the meeting in **long** format, represented as int64 data type in JSON. Also known as the meeting number."
},
"type": {
"enum": [
1,
2,
3,
8
],
"type": "integer",
"example": 2,
"extensions": {
"x-enum-descriptions": [
"Instant Meeting",
"Scheduled Meeting",
"Recurring Meeting with no fixed time",
"Recurring Meeting with fixed time"
]
},
"description": "Meeting types.\n`1` - Instant meeting.\n`2` - Scheduled meeting.\n`3` - Recurring meeting with no fixed time.\n`8` - Recurring meeting with fixed time."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "The meeting topic."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Meeting duration."
},
"join_url": {
"type": "string",
"example": "https://example.com/j/11111",
"description": "The URL that participants can use to join a meeting."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The timezone to format the meeting start time."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T05:31:16Z",
"description": "The meeting creation time."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T06:00:00Z",
"description": "The meeting's start time."
}
}
},
"description": "List of upcoming meeting objects."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The total number of all records available across all pages."
}
}
}
MeetingsLivestreamStatusUpdateRequest
{
"type": "object",
"properties": {
"action": {
"enum": [
"start",
"stop",
"mode"
],
"type": "string",
"example": "start",
"description": "The meeting's livestream status.\n* `start` - Start a livestream.\n* `stop` - Stop an ongoing livestream.\n* `mode` - Control a livestream view at runtime."
},
"settings": {
"type": "object",
"properties": {
"layout": {
"enum": [
"follow_host",
"gallery_view",
"speaker_view"
],
"type": "string",
"default": "follow_host",
"example": "follow_host",
"description": "The layout of the meeting's livestream. Use this field if you pass the `start` or `mode` value for the `action` field.\r\n* `follow_host` - Follow host view.\r\n* `gallery_view` - Gallery view.\r\n* `speaker_view` - Speaker view."
},
"display_name": {
"type": "string",
"example": "Jill Chill",
"maxLength": 50,
"minLength": 1,
"description": "The display name of the meeting's livestream. Use this field if you pass the `start` value for the `action` field."
},
"close_caption": {
"enum": [
"burnt-in",
"embedded",
"off"
],
"type": "string",
"default": "burnt-in",
"example": "burnt-in",
"description": "The livestream's closed caption type for this session. Use this field if you pass the `start` or `mode` value for the `action` field.\r\n* `burnt-in` - Burnt in captions.\r\n* `embedded` - Embedded captions.\r\n* `off` - Turn off captions."
},
"active_speaker_name": {
"type": "boolean",
"example": true,
"description": "Whether to display the name of the active speaker during a meeting's livestream. Use this field if you pass the `start` value for the `action` field."
}
},
"description": "The meeting's livestreaming settings."
}
},
"description": "The meeting's livestream status."
}
MeetingsUpdateDetailsRequest
{
"type": "object",
"properties": {
"type": {
"enum": [
1,
2,
3,
8
],
"type": "integer",
"default": 2,
"example": 2,
"extensions": {
"x-enum-descriptions": [
"Instant Meeting",
"Scheduled Meeting",
"Recurring Meeting with no fixed time",
"Recurring Meeting with fixed time"
]
},
"description": "Meeting types.\n `1` - Instant meeting. \n `2` - Scheduled meeting. \n `3` - Recurring meeting with no fixed time. \n `8` - Recurring meeting with a fixed time."
},
"topic": {
"type": "string",
"example": "My Meeting",
"maxLength": 200,
"description": "Meeting topic."
},
"agenda": {
"type": "string",
"example": "My Meeting",
"maxLength": 2000,
"description": "Meeting description."
},
"duration": {
"type": "integer",
"example": 60,
"description": "Meeting duration in minutes. Used for scheduled meetings only."
},
"password": {
"type": "string",
"example": "123456",
"maxLength": 10,
"description": "Meeting passcode. Passcodes may only contain these characters [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.\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, 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 meeting. \n `both` - Both Telephony and VoIP. \n `telephony` - Telephony only. \n `voip` - VoIP only. \n `thirdParty` - Third party audio conference."
},
"use_pmi": {
"type": "boolean",
"default": false,
"example": false,
"description": "Use a [personal meeting ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time."
},
"jbh_time": {
"enum": [
0,
5,
10
],
"type": "integer",
"example": 0,
"description": "If the value of `join_before_host` field is set to true, use this field to indicate time limits for a participant to join a meeting before a host.\n\n* `0` - Allow participant to join anytime.\n* `5` - Allow participant to join 5 minutes before meeting start time.\n * `10` - Allow participant to join 10 minutes before meeting start time."
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resource_id": {
"type": "string",
"example": "X4Hy02w3QUOdskKofgb9Jg",
"description": "The resource ID."
},
"resource_type": {
"enum": [
"whiteboard"
],
"type": "string",
"example": "whiteboard",
"description": "The resource type."
},
"permission_level": {
"enum": [
"editor",
"commenter",
"viewer"
],
"type": "string",
"default": "editor",
"example": "editor",
"description": "The permission levels for users to access the whiteboard. \n* `editor` - Users with link access can edit the board. \n* `commenter` - Users with link access can comment on the board. \n* `viewer` - Users with link access can view the board."
}
}
},
"description": "The meeting's resources."
},
"watermark": {
"type": "boolean",
"default": false,
"example": false,
"description": "Add a watermark when viewing a shared screen."
},
"cn_meeting": {
"type": "boolean",
"default": false,
"example": false,
"deprecated": true,
"description": "Host the meeting in China."
},
"focus_mode": {
"type": "boolean",
"example": true,
"description": "Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts."
},
"host_video": {
"type": "boolean",
"example": true,
"description": "Start video when the host joins the meeting."
},
"in_meeting": {
"type": "boolean",
"default": false,
"example": false,
"deprecated": true,
"description": "Host meeting in India."
},
"custom_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "key1",
"maxLength": 64,
"description": "Custom key associated with the user."
},
"value": {
"type": "string",
"example": "value1",
"maxLength": 256,
"description": "Value of the custom key associated with the user."
}
}
},
"maxItems": 10,
"description": "Custom keys and values assigned to the meeting."
},
"contact_name": {
"type": "string",
"example": "Jill Chill",
"description": "Contact name for registration."
},
"waiting_room": {
"type": "boolean",
"default": false,
"example": false,
"description": "Enable waiting room."
},
"approval_type": {
"enum": [
0,
1,
2
],
"type": "integer",
"default": 2,
"example": 0,
"extensions": {
"x-enum-descriptions": [
"Automatically Approve",
"Manually Approve",
"No Registration Required"
]
},
"description": "Enable registration and set approval for the registration. Note that this feature requires the host to be of **Licensed** user type. **Registration cannot be enabled for a basic user.** \n \n \n\n`0` - Automatically approve. \n `1` - Manually approve. \n `2` - No registration required."
},
"breakout_room": {
"type": "object",
"properties": {
"rooms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "room1",
"description": "The breakout room's name."
},
"participants": {
"type": "array",
"items": {
"type": "string",
"example": "jchill@example.com"
},
"description": "Email addresses of the participants who are to be assigned to the breakout room."
}
}
},
"description": "Create room(s)."
},
"enable": {
"type": "boolean",
"example": true,
"description": "Set this field's value to `true` to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option."
}
},
"description": "Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4)."
},
"calendar_type": {
"enum": [
1,
2
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Outlook",
"Google Calendar"
]
},
"description": "The type of calendar integration used to schedule the meeting. \n* `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings."
},
"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 meeting."
},
"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."
},
"encryption_type": {
"enum": [
"enhanced_encryption",
"e2ee"
],
"type": "string",
"example": "enhanced_encryption",
"description": "Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features such cloud recording and phone/SIP/H.323 dial-in, will be **automatically disabled**. \n\n`enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud if you enable this option. \n \n\n`e2ee` - [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the features join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions."
},
"mute_upon_entry": {
"type": "boolean",
"default": false,
"example": false,
"description": "Mute participants upon entry."
},
"private_meeting": {
"type": "boolean",
"example": false,
"description": "Whether the meeting is set as private."
},
"internal_meeting": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to set the meeting as an internal meeting."
},
"join_before_host": {
"type": "boolean",
"default": false,
"example": true,
"description": "Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings."
},
"meeting_invitees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "jchil@example.com",
"description": "The invitee's email address."
}
}
},
"description": "A list of the meeting's invitees."
},
"alternative_hosts": {
"type": "string",
"example": "jchill@example.com;thill@example.com",
"description": "A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."
},
"participant_video": {
"type": "boolean",
"example": false,
"description": "Start video when participants join the meeting."
},
"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 type. Used for recurring meeting with fixed time only.\n `1` - Attendees register once and can attend any of the occurrences. \n `2` - Attendees need to register for each occurrence to attend. \n `3` - Attendees register once and can choose one or more occurrences to attend."
},
"show_share_button": {
"type": "boolean",
"example": true,
"description": "Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting)."
},
"close_registration": {
"type": "boolean",
"default": false,
"example": false,
"description": "Close registration after the event date."
},
"email_notification": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`."
},
"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)."
},
"audio_conference_info": {
"type": "string",
"example": "test",
"maxLength": 2048,
"description": "Third party audio conference info."
},
"authentication_option": {
"type": "string",
"example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"description": "Meeting 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 meeting."
},
"host_save_video_order": {
"type": "boolean",
"example": true,
"description": "Whether the **Allow host to save video order** feature is enabled."
},
"allow_multiple_devices": {
"type": "boolean",
"example": true,
"description": "Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting)."
},
"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."
},
"global_dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string",
"example": "New York",
"description": "City of the number, if any, such as Chicago."
},
"type": {
"enum": [
"toll",
"tollfree"
],
"type": "string",
"example": "toll",
"description": "Type of number. "
},
"number": {
"type": "string",
"example": "+1 1000200200",
"description": "Phone number, such as +1 2332357613."
},
"country": {
"type": "string",
"example": "US",
"description": "Country code, such as BR."
},
"country_name": {
"type": "string",
"example": "US",
"description": "Full name of country, such as Brazil."
}
}
},
"description": "Global dial-in countries or regions"
},
"meeting_authentication": {
"type": "boolean",
"example": true,
"description": "`true`- Only authenticated users can join meetings."
},
"continuous_meeting_chat": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Whether to enable the **Enable continuous meeting chat** setting."
},
"auto_add_invited_external_users": {
"type": "boolean",
"example": true,
"description": "Whether to enable the **Automatically add invited external users** setting."
}
},
"description": "Information about the **Enable continuous meeting chat** feature."
},
"language_interpretation": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting."
},
"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,FR",
"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 meeting's language interpreters."
}
},
"description": "The meeting'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 Meeting 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 meeting."
},
"authentication_exception": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's name."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The participant's email address."
},
"join_url": {
"type": "string",
"example": "https://example.com/s/11111",
"description": "URL for participants to join the meeting"
}
}
},
"description": "The participants added here will receive unique meeting invite links and bypass authentication."
},
"global_dial_in_countries": {
"type": "array",
"items": {
"type": "string",
"example": "US"
},
"description": "List of global dial-in countries"
},
"auto_start_meeting_summary": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to automatically start meeting summary."
},
"participant_focused_meeting": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to set the meeting as a participant focused meeting."
},
"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 meeting."
},
"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 meeting's sign language interpreters."
}
},
"description": "The meeting'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 meeting."
},
"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."
},
"registrants_confirmation_email": {
"type": "boolean",
"example": true,
"description": "Whether to send registrants an email confirmation.\n* `true` - Send a confirmation email.\n* `false` - Do not send a confirmation email."
},
"registrants_email_notification": {
"type": "boolean",
"example": true,
"description": "Whether to send registrants email notifications about their registration approval, cancellation, or rejection.\n\n* `true` - Send an email notification.\n* `false` - Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter."
},
"auto_start_ai_companion_questions": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to automatically start AI Companion questions."
},
"alternative_hosts_email_notification": {
"type": "boolean",
"default": true,
"example": true,
"description": "Flag to determine whether to send email notifications to alternative hosts, default value is true."
},
"approved_or_denied_countries_or_regions": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"example": true,
"description": "`true` - Setting enabled to either allow users or block users from specific regions to join your meetings.\n \n\n`false` - Setting disabled."
},
"method": {
"enum": [
"approve",
"deny"
],
"type": "string",
"example": "approve",
"description": "Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting.\n\n \n`approve` - Allow users from specific regions or countries to join this meeting. If this setting is selected, include the approved regions or countries in the `approved_list`. \n\n\n`deny` - Block users from specific regions or countries from joining this meeting. If this setting is selected, include the approved regions orcountries in the `denied_list`"
},
"denied_list": {
"type": "array",
"items": {
"type": "string",
"example": "CA"
},
"description": "List of countries or regions from where participants can not join this meeting. "
},
"approved_list": {
"type": "array",
"items": {
"type": "string",
"example": "CX"
},
"description": "List of countries or regions from where participants can join this meeting. "
}
},
"description": "Approve or block users from specific regions or countries from joining this meeting. \n"
}
},
"description": "Meeting settings."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The timezone to assign to the `start_time` value. Only use this field ifor scheduled or recurring meetings 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",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
1,
2,
3
],
"type": "integer",
"example": 1,
"extensions": {
"x-enum-descriptions": [
"Daily",
"Weekly",
"Monthly"
]
},
"description": "Recurrence meeting 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 meeting should recur before it is canceled. If `end_times` is set to 0, it means there is no end time. The maximum number of recurrences is 60. Cannot be used with `end_date_time`."
},
"monthly_day": {
"type": "integer",
"default": 1,
"example": 1,
"description": "Use this field **only if you're scheduling a recurring meeting of type** `3` to state the day in a month when the meeting should recur. The value range is from 1 to 31.\n\nFor instance, if the meeting should recur on 23rd of each month, provide `23` as this field's value and `1` as the `repeat_interval` field's value. If the meeting should recur every three months on 23rd of the month, change the `repeat_interval` field's value to `3`."
},
"weekly_days": {
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7"
],
"type": "string",
"default": "1",
"example": "1",
"description": "This field is required if you're scheduling a recurring meeting of type `2`, to state which days of the week the meeting should repeat. \n\nThiw field's value could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field's value. \n \n **Note** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `1,3` as this field's value.\n\n \n `1` - Sunday. \n `2` - Monday. \n `3` - Tuesday. \n `4` - Wednesday. \n `5` - Thursday. \n `6` - Friday. \n `7` - Saturday."
},
"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 meeting of type** `3` to state the week of the month when the meeting 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 meeting 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 the final date when the meeting recurs 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 meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field's value as `2` and the `type` parameter's value to `3`. \n\nFor a daily meeting, the maximum interval is `90` days. For a weekly meeting, the maximum interval is `12` weeks. For a monthly meeting, the maximum value is `3` months.\n\n"
},
"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 meeting of type `3` to state a specific day in a week when a monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n \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 meeting with type `8`, a recurring meeting with fixed time. "
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-25T07:29:29Z",
"description": "Meeting start time. When using a format like `yyyy-MM-dd'T'HH:mm:ss'Z'`, always use GMT time. When using a format like `yyyy-MM-dd'T'HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time."
},
"template_id": {
"type": "string",
"example": "5Cj3ceXoStO6TGOVvIOVPA==",
"description": "Unique identifier of the meeting template. \n\n[Schedule the meeting from a meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates#h_86f06cff-0852-4998-81c5-c83663c176fb). Retrieve this field's value by calling the [List meeting templates](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/listMeetingTemplates) API."
},
"pre_schedule": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether to create a prescheduled meeting through the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` - scheduled meetings- and `3` - recurring meetings with no fixed time. \n* `true` - Create a prescheduled meeting. \n* `false` - Create a regular meeting."
},
"schedule_for": {
"type": "string",
"example": "jchill@example.com",
"description": "The email address or `userId` of the user to schedule a meeting for."
},
"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."
}
},
"description": "Meeting object."
}
MeetingsUpdateLivestreamRequest
{
"type": "object",
"required": [
"page_url",
"stream_key",
"stream_url"
],
"properties": {
"page_url": {
"type": "string",
"format": "uri",
"example": "https://example.com/livestream/123",
"maxLength": 1024,
"description": "The live stream page URL."
},
"resolution": {
"type": "string",
"example": "720p",
"description": "The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`"
},
"stream_key": {
"type": "string",
"example": "contact-it@example.com",
"maxLength": 512,
"description": "Stream name and key."
},
"stream_url": {
"type": "string",
"example": "https://example.com/livestream",
"maxLength": 1024,
"description": "Streaming URL."
}
},
"description": "Meeting live stream."
}
MeetingsUpdateMeetingPollRequest
{
"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."
}
MeetingsUpdateMeetingStatusRequest
{
"type": "object",
"properties": {
"action": {
"enum": [
"end",
"recover"
],
"type": "string",
"example": "recover",
"description": "`end` - End a meeting. \n \n`recover` - [Recover](https://support.zoom.us/hc/en-us/articles/360038297111-Recover-a-deleted-meeting) a deleted meeting.\n"
}
}
}
MeetingsUpdateMessageRequest
{
"type": "object",
"required": [
"message_content"
],
"properties": {
"message_content": {
"type": "string",
"example": "This is a test message",
"description": "The content of the chat message."
}
}
}
MeetingsUpdateRegistrantStatusRequest
{
"type": "object",
"required": [
"action"
],
"properties": {
"action": {
"enum": [
"approve",
"cancel",
"deny"
],
"type": "string",
"example": "approve",
"extensions": {
"x-enum-descriptions": [
"Approve registrant",
"Cancel previously approved registrant",
"Deny registrant"
]
},
"description": "Registrant Status: \n `approve` - Approve registrant. \n `cancel` - Cancel previously approved registrant's registration. \n `deny` - Deny registrant."
},
"registrants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "9tboDiHUQAeOnbmudzWa5g"
},
"email": {
"type": "string",
"example": "jchill@example.com"
}
}
},
"maximum": 30,
"description": "List of registrants."
}
}
}
MeetingsUpdateRegistrationQuestionsRequest
{
"type": "object",
"title": "Meeting Registrant Questions",
"properties": {
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"example": true,
"description": "Indicates whether or not the displayed fields are required to be filled out by registrants."
},
"field_name": {
"enum": [
"last_name",
"address",
"city",
"country",
"zip",
"state",
"phone",
"industry",
"org",
"job_title",
"purchasing_time_frame",
"role_in_purchase_process",
"no_of_employees",
"comments"
],
"type": "string",
"example": "last_name",
"description": "Field name of the question."
}
}
},
"description": "Array of Registrant Questions"
},
"custom_questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"short",
"single"
],
"type": "string",
"example": "short",
"extensions": {
"x-enum-descriptions": [
"Short Answer",
"Single Answer"
]
},
"description": "Type of the question being asked."
},
"title": {
"type": "string",
"example": "How are you?",
"description": "Title of the custom question."
},
"answers": {
"type": "array",
"items": {
"type": "string",
"example": "Good"
},
"description": "Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer."
},
"required": {
"type": "boolean",
"example": true,
"description": "Indicates whether or not the custom question is required to be answered by participants or not."
}
}
},
"description": "Array of Registrant Custom Questions"
}
},
"description": "Meeting Registrant Questions"
}
MeetingsUpdateSurveyRequest
{
"type": "object",
"title": "Meeting 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\n This value defaults to `true`."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "How useful was this meeting?",
"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 meeting 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 meeting survey."
},
"third_party_survey": {
"type": "string",
"example": "https://example.com",
"maxLength": 64,
"description": "The link to the third party meeting survey."
},
"show_in_the_browser": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether the **Show in the browser when the meeting ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
}
},
"description": "Information about the meeting survey."
}
PacListAccountsResponse
{
"type": "object",
"properties": {
"pac_accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conference_id": {
"type": "integer",
"format": "int64",
"example": 111111,
"description": "The conference ID."
},
"listen_only_password": {
"type": "string",
"example": "3c2b1a",
"maxLength": 6,
"description": "The listen-only password, up to six characters in length."
},
"participant_password": {
"type": "string",
"example": "a1b2c3",
"maxLength": 6,
"description": "The participant password, up to six characters in length."
},
"global_dial_in_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "5550100",
"maxLength": 16,
"description": "The global dial-in number."
},
"country": {
"type": "string",
"example": "USA",
"description": "The global dial-in country code."
}
}
},
"description": "Information about the account's global dial-in numbers."
},
"dedicated_dial_in_number": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"example": "5550110",
"maxLength": 16,
"description": "The dial-in number."
},
"country": {
"type": "string",
"example": "USA",
"description": "The dial-in country code."
}
}
},
"description": "Information about the account's dedicated dial-in numbers."
}
}
},
"description": "Information about the PAC accounts."
}
}
}
ReportsGetActiveInactiveHostReportsResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "End date for this report."
},
"from": {
"type": "string",
"format": "date",
"example": "2022-03-01",
"description": "Start date for this report."
},
"users": {
"type": "array",
"items": {
"type": "array of objects",
"properties": {
"id": {
"type": "string",
"example": "2pyjK5VNQHadb2BY6Z4GbA",
"description": "User ID."
},
"dept": {
"type": "string",
"example": "HR",
"description": "User department."
},
"type": {
"type": "integer",
"example": 1,
"description": "User type."
},
"email": {
"type": "string",
"example": "jchill@example.com",
"description": "User email."
},
"meetings": {
"type": "integer",
"example": 45,
"description": "Number of meetings for user."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"description": "User display name."
},
"participants": {
"type": "integer",
"example": 56,
"description": "Number of participants in meetings for user."
},
"meeting_minutes": {
"type": "integer",
"example": 342,
"description": "Number of meeting minutes for user."
},
"custom_attributes": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "Identifier for the custom attribute."
},
"name": {
"type": "string",
"example": "age",
"description": "Name of the custom attribute."
},
"value": {
"type": "string",
"example": "18",
"description": "Value of the custom attribute."
}
}
},
"description": "Custom attributes that have been assigned to the user."
}
}
},
"description": "Array of user objects."
},
"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": 30,
"description": "The number of pages returned for the request made."
},
"page_number": {
"type": "integer",
"default": 1,
"example": 1,
"description": "The page number of the current results."
},
"total_records": {
"type": "integer",
"example": 850,
"description": "The total number of all the records available across pages."
},
"total_meetings": {
"type": "integer",
"example": 34,
"description": "Number of meetings for this range."
},
"next_page_token": {
"type": "string",
"example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
"total_participants": {
"type": "integer",
"example": 56,
"description": "Number of participants for this range."
},
"total_meeting_minutes": {
"type": "integer",
"example": 345,
"description": "Number of meeting minutes for this range."
}
}
}
ReportsGetBillingDepartmentReportsResponse
{
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Currency of the billed amount."
},
"billing_reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "indfhgfhfho",
"description": "Unique Identifier of the report. Use this ID to retrieve billing invoice via the "Get Billing Invoices API". \n\nYou can also use this ID to export a CSV file of the billing report from this URL: `https://zoom.us/account/report/billing/export?id={id}`."
},
"type": {
"enum": [
0,
1
],
"type": "integer",
"example": 1,
"description": "Type of the billing report. The value should be either of the following: \n \n`0` - Detailed Billing Reports\n`1` - Custom Billing Reports"
},
"end_date": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "End date of the billing period."
},
"start_date": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "Start date of the billing period."
},
"tax_amount": {
"type": "string",
"example": "456",
"description": "Total tax amount for this billing period."
},
"total_amount": {
"type": "string",
"example": "456",
"description": "Total billing amount for this billing period."
}
}
}
}
}
}
ReportsGetBillingInvoicesResponse
{
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Currency of the billed amount in the invoice."
},
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "End date of the invoice period."
},
"quantity": {
"type": "integer",
"example": 45,
"description": "Number of licenses bought."
},
"start_date": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "Start date of the invoice period."
},
"tax_amount": {
"type": "string",
"example": "34",
"description": "Tax amount in the invoice."
},
"total_amount": {
"type": "string",
"example": "45",
"description": "Total billed amount in the invoice."
},
"invoice_number": {
"type": "string",
"example": "3",
"description": "Invoice number "
},
"invoice_charge_name": {
"type": "string",
"example": "Audio Conferencing Options",
"description": "Name of the invoice."
}
}
}
}
}
}
ReportsGetCloudRecordingUsageReportResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"example": "2021-12-30",
"description": "End date for this report"
},
"from": {
"type": "string",
"format": "date",
"example": "2021-12-01",
"description": "Start date for this report"
},
"cloud_recording_storage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2021-12-05",
"description": "Date of the usage"
},
"usage": {
"type": "string",
"example": "3 MB",
"description": "Storage used on the date"
},
"free_usage": {
"type": "string",
"example": "Unlimited",
"description": "Free storage"
},
"plan_usage": {
"type": "string",
"example": "3 TB",
"description": "Paid storage"
}
}
},
"description": "Array of cloud usage objects"
}
}
}
ReportsGetDailyUsageReportResponse
{
"type": "object",
"properties": {
"year": {
"type": "integer",
"example": 2022,
"description": "Year for this report."
},
"dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2022-03-01",
"description": "Date for this object."
},
"meetings": {
"type": "integer",
"example": 2,
"description": "Number of meetings on this date."
},
"new_users": {
"type": "integer",
"example": 3,
"description": "Number of new users on this date."
},
"participants": {
"type": "integer",
"example": 4,
"description": "Number of participants on this date."
},
"meeting_minutes": {
"type": "integer",
"example": 34,
"description": "Number of meeting minutes on this date."
}
}
},
"description": "Array of date objects."
},
"month": {
"type": "integer",
"example": 3,
"description": "Month for this report."
}
}
}
ReportsGetMeetingDetailReportsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 3927350525,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number."
},
"dept": {
"type": "string",
"example": "HR",
"description": "Department of the host."
},
"type": {
"type": "integer",
"example": 2,
"description": "Meeting type."
},
"uuid": {
"type": "string",
"example": "iOTQZPmhTUq5a232ETb9eg==",
"description": "Meeting UUID. Each meeting instance will generate its own UUID(i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). [Double encode](https://marketplace.zoom.us/docs/api-reference/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."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "Meeting topic."
},
"duration": {
"type": "integer",
"example": 2,
"description": "Meeting duration."
},
"end_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:42:22Z",
"description": "Meeting end time."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"description": "User display name."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:40:46Z",
"description": "Meeting start time."
},
"user_email": {
"type": "string",
"example": "jchill@example.com",
"description": "User email."
},
"custom_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "Host Nation",
"maxLength": 64,
"description": "Custom key associated with the user."
},
"value": {
"type": "string",
"example": "US",
"maxLength": 256,
"description": "Value of the custom key associated with the user."
}
}
},
"maxItems": 10,
"description": "Custom keys and values assigned to the meeting."
},
"total_minutes": {
"type": "integer",
"example": 3,
"description": "Number of meeting minutes. This represents the total amount of meeting minutes attended by each participant including the host, for meetings hosted by the user. For instance if there were one host(named A) and one participant(named B) in a meeting, the value of total_minutes would be calculated as below:\n\n**total_minutes** = Total Meeting Attendance Minutes of A + Total Meeting Attendance Minutes of B"
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "Host Nation",
"description": "Tracking fields type."
},
"value": {
"type": "string",
"example": "US",
"description": "Tracking fields value."
}
}
},
"description": "Tracking fields."
},
"participants_count": {
"type": "integer",
"example": 2,
"description": "Number of meeting participants."
}
}
}
ReportsGetMeetingParticipantReportsResponse
{
"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": "30R7kT7bTIKSNUFEuH_Qlg",
"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": "example",
"description": "Participant display name.\n\nThis 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": "27423744",
"description": "Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only."
},
"duration": {
"type": "integer",
"example": 259,
"description": "Participant duration."
},
"failover": {
"type": "boolean",
"example": false,
"description": "Indicates if failover happened during the meeting."
},
"bo_mtg_id": {
"type": "string",
"example": "27423744",
"description": "The [breakout room](https://support.zoom.us/hc/en-us/articles/206476313-Managing-breakout-rooms) ID. Each breakout room is assigned a unique ID."
},
"join_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T06:58:09Z",
"description": "Participant join time."
},
"leave_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-23T07:02:28Z",
"description": "Participant leave time."
},
"user_email": {
"type": "string",
"example": "jchill@example.com",
"description": "Participant email.\n\nIf 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": "abcdefghij0-klmnopq23456",
"description": "Unique identifier of the registrant. This field is only returned if you entered "registrant_id" as the value of `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": "Array of meeting participant objects."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The number of all records available across pages."
},
"next_page_token": {
"type": "string",
"example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
},
"description": "Pagination object."
}
ReportsGetMeetingPollReportsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID)."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's display name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `name` field will return the "Anonymous Attendee" value."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The participant's email address."
},
"last_name": {
"type": "string",
"example": "Chill",
"description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `last_name` field will return the "Anonymous Attendee" value."
},
"first_name": {
"type": "string",
"example": "Jill",
"description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `first_name` field will return the "Anonymous Attendee" value."
},
"question_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "I am wonderful.",
"description": "The user's given answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "The poll question."
},
"date_time": {
"type": "string",
"example": "2022-02-01T12:37:12.660Z",
"description": "The date and time at which the user answered the poll question."
},
"polling_id": {
"type": "string",
"example": "798fGJEWrA",
"description": "The poll's ID."
}
}
},
"description": "Information about the user's questions and answers."
}
}
},
"description": "Information about the meeting questions."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-02-01T12:34:12.660Z",
"description": "The meeting's start time."
}
}
}
ReportsGetMeetingQaReportResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 245603123123,
"description": "The meeting ID in `long` format, represented as int64 data type in JSON. Also known as the meeting number."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The meeting UUID. Each meeting instance will generate its own UUID - for example, after a meeting ends, a new UUID will be generated for the next instance of the meeting. Double-encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//'."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "Participant's display name. \n \n\nIf the anonymous [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) option is enabled and if a participant submits the Q&A without providing their name, the value of the `name` field is "Anonymous Attendee"."
},
"email": {
"type": "string",
"example": "jchilll@example.com",
"description": "Participant's email. 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."
},
"user_id": {
"type": "string",
"example": "hyROrs0TRCSvwmadI7L13w",
"description": "The user ID of the user who asked the question. This value returns blank for external users."
},
"question_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "fine",
"deprecated": true,
"description": "The given answer. If this is a live answer, the value is 'live answered'.\n**Note:** All answers will be returned together and separated by semicolons. For more detailed answer information, please see the \"answer_details\" field."
},
"question": {
"type": "string",
"example": "how are you",
"description": "Asked question."
},
"create_time": {
"type": "string",
"example": "2022-03-15T07:48:00Z",
"description": "Question create time."
},
"question_id": {
"type": "string",
"example": "zxU4wOwnlxs",
"description": "Question UUID."
},
"answer_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Paul",
"description": "User display name, including the host or participant."
},
"type": {
"enum": [
"default",
"host_answered",
"participant_commented"
],
"type": "string",
"default": "default",
"example": "default",
"extensions": {
"x-enum-description": [
"default - default value, does not represent any type",
"host_answered - answer from the host",
"participant_commented - comment from the participant"
]
},
"description": "Type of answer."
},
"email": {
"type": "string",
"example": "paul@example.com",
"description": "Participant's email. 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."
},
"content": {
"type": "string",
"example": "fine",
"maxLength": 1024,
"description": "The answer from host or the comment from participant."
},
"user_id": {
"type": "string",
"example": "Cn_5wJ9mRNGyYOmpjVufBQ",
"description": "The user ID of the user who answered the question. This value returns blank for external users."
},
"create_time": {
"type": "string",
"example": "2022-03-15T07:50:00Z",
"description": "Content submit time."
}
}
},
"description": "Array of answers from the user."
}
}
},
"description": "Array of questions from user."
}
}
},
"description": "Array of meeting question objects."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:40:46Z",
"description": "Meeting start time."
}
}
}
ReportsGetMeetingReportsResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"example": "2020-08-14",
"description": "The report's end date."
},
"from": {
"type": "string",
"format": "date",
"example": "2020-07-14",
"description": "The report's start date."
},
"meetings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12345,
"description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID)."
},
"type": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type": "integer",
"example": 2,
"description": "The type of meeting or webinar. \n\nmeeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\nwebinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time \n* `9` — A recurring webinar with a fixed time. "
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "The meeting's topic."
},
"source": {
"type": "string",
"example": "Zoom",
"description": "Whether the meeting was created directly through Zoom or via an API request: \n* If the meeting was created via an OAuth app, this field returns the OAuth app's name. \n* If the meeting was created via JWT or the Zoom Web Portal, this returns the `Zoom` value."
},
"duration": {
"type": "integer",
"example": 6,
"description": "The meeting's duration."
},
"end_time": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T23:30:19Z",
"description": "The meeting's end date and time."
},
"has_chat": {
"type": "boolean",
"example": false,
"description": "Indicates whether or not the chat feature was used in the meeting."
},
"host_name": {
"type": "string",
"example": "Jill",
"description": "Host's name."
},
"join_time": {
"type": "string",
"example": "12/22/2021 16:20",
"description": "The date and time at which the attendee joined the meeting."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"description": "The user's display name."
},
"leave_time": {
"type": "string",
"example": "12/22/2021 17:13",
"description": "The date and time at which the attendee left the meeting."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2019-07-15T23:24:52Z",
"description": "The meeting's start date and time."
},
"user_email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The user's email address."
},
"custom_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "Host Nation",
"maxLength": 64,
"description": "The custom key name."
},
"value": {
"type": "string",
"example": "US",
"maxLength": 256,
"description": "The custom key's value."
}
}
},
"maxItems": 10,
"description": "Information about the meeting's assigned custom keys and values. This returns a maximum of 10 items."
},
"session_key": {
"type": "string",
"example": "ABC36jaBI145",
"description": "The Video SDK custom session ID."
},
"has_recording": {
"type": "boolean",
"example": false,
"description": "Indicates whether or not the recording feature was used in the meeting."
},
"schedule_time": {
"type": "string",
"example": "12/22/2021 16:20",
"description": "The meeting's scheduled date and time."
},
"total_minutes": {
"type": "integer",
"example": 11,
"description": "The sum of meeting minutes from all meeting participants in the meeting."
},
"has_screen_share": {
"type": "boolean",
"example": false,
"description": "Indicates whether or not the screenshare feature was used in the meeting."
},
"host_organization": {
"type": "string",
"example": "org",
"description": "Host Account Name of Hosting Organization."
},
"participants_count": {
"type": "integer",
"example": 2,
"description": "The number of meeting participants."
},
"join_waiting_room_time": {
"type": "string",
"example": "02/11/2022 16:15",
"description": "The date and time at which the attendee joined the waiting room."
},
"meeting_encryption_status": {
"enum": [
1,
2
],
"type": "integer",
"example": 1,
"description": "The meeting's encryption status. \n* `1` — E2E encryption. \n* `2` — Enhanced encryption."
},
"participants_count_my_account": {
"type": "integer",
"example": 2,
"description": "The number of meeting participants from my account."
}
}
},
"description": "Information about the meeting."
},
"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.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
},
"total_records": {
"type": "integer",
"example": 20,
"description": "The total number of all the records available across pages."
},
"next_page_token": {
"type": "string",
"example": "w7587w4eiyfsudgk",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
},
"description": "Pagination Object."
}
ReportsGetMeetingSurveyReportResponse
{
"type": "object",
"properties": {
"survey_id": {
"type": "string",
"example": "8SFHRTGHAAAiAAAAAiAiAiiAii==",
"description": "The survey's ID"
},
"meeting_id": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "The meeting ID."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-02-01T12:34:12.660Z",
"description": "The meeting's start time."
},
"survey_name": {
"type": "string",
"example": "Survey of this meeting",
"description": "The name of survey"
},
"meeting_uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
},
"survey_answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `name` field will return the "Anonymous Attendee" value."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The participant's email address."
},
"last_name": {
"type": "string",
"example": "Chill",
"description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `last_name` field will return the "Anonymous Attendee" value."
},
"first_name": {
"type": "string",
"example": "Jill",
"description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `first_name` field will return the "Anonymous Attendee" value."
},
"answer_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "I am wonderful.",
"description": "The user's given answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "The survey question."
},
"date_time": {
"type": "string",
"example": "2022-02-01T12:37:12.660Z",
"description": "The date and time at which the user answered the survey question."
},
"question_id": {
"type": "string",
"example": "798fGJEWrA",
"description": "The question's ID"
}
}
},
"description": "Information about the user's questions and answers."
}
}
},
"description": "Information about the survey questions and answers."
}
}
}
ReportsGetOperationLogsReportResponse
{
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The amount of records returns within a single API call. "
},
"operation_logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"example": "2022-01-25T17:52:16Z",
"description": "The time at which the operation was performed."
},
"action": {
"type": "string",
"example": "delete",
"description": "Action"
},
"operator": {
"type": "string",
"example": "admin@example.com",
"description": "The user who performed the operation."
},
"category_type": {
"type": "string",
"example": "user",
"description": "Category type"
},
"operation_detail": {
"type": "string",
"example": "delete user - user2@example.com",
"description": "Operation detail"
}
}
},
"description": "Array of operation log objects"
},
"next_page_token": {
"type": "string",
"example": "uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of the available result list exceeds the page size. The expiration period is 15 minutes."
}
},
"description": "Pagination object."
}
ReportsGetTelephoneReportsResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"example": "2019-07-20",
"description": "End date for this report."
},
"from": {
"type": "string",
"format": "date",
"example": "2019-06-20",
"description": "Start date for this report."
},
"page_size": {
"type": "integer",
"example": 30,
"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. This field does **not** return if the `query_date_type` parameter is the `meeting_start_time` or `meeting_end_time` value."
},
"total_records": {
"type": "integer",
"example": 1,
"description": "The total number of all the records available across pages. This field does **not** return if the `query_date_type` parameter is the `meeting_start_time` or `meeting_end_time` value."
},
"next_page_token": {
"type": "string",
"example": "w7587w4eiyfsudgk",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
"telephony_usage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dept": {
"type": "string",
"example": "HR",
"description": "User department."
},
"rate": {
"type": "number",
"example": 0.03,
"description": "Calling rate for the telephone call."
},
"type": {
"enum": [
"toll-free",
"call-out",
"call-in",
"US toll-number",
"global toll-number",
"premium",
"premium call-in",
"Toll"
],
"type": "string",
"example": "call-out",
"description": "Call type."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "Meeting UUID."
},
"total": {
"type": "number",
"example": 0.03,
"description": "Total cost (USD) for Call Out. Calculated as plan rate by duration."
},
"host_id": {
"type": "string",
"example": "_Rn_hal7ToG5p0AWwIIsjQ",
"description": "The user ID of the meeting host."
},
"duration": {
"type": "integer",
"example": 2,
"description": "Call leg duration"
},
"end_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:42:22Z",
"description": "Call leg end time"
},
"host_name": {
"type": "string",
"example": "Jill Chill",
"description": "User display name."
},
"host_email": {
"type": "string",
"example": "jchill@example.com",
"description": "User email."
},
"meeting_id": {
"type": "integer",
"format": "int64",
"example": 94908911701,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:40:46Z",
"description": "Call leg start time"
},
"country_name": {
"type": "string",
"example": "US",
"description": "Country name."
},
"meeting_type": {
"type": "string",
"example": "Meeting",
"description": "Meeting type."
},
"phone_number": {
"type": "string",
"example": "+1 8243",
"description": "Toll-free telephone number. "
},
"call_in_number": {
"type": "string",
"example": "ZoomGW",
"description": "Caller's call-in number."
},
"signaled_number": {
"type": "string",
"example": "+1 8243",
"description": "The number that is signaled to Zoom. "
}
}
},
"description": "Array of telephony objects."
}
}
}
ReportsGetWebinarDetailsReportResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 345678902224,
"description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number."
},
"dept": {
"type": "string",
"example": "HR",
"description": "Department of the host."
},
"type": {
"type": "integer",
"example": 4,
"description": "Meeting type."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "Webinar UUID. Each webinar instance will generate its own UUID(i.e., after a meeting ends, a new UUID will be generated when the next instance of the webinar starts). [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "Meeting topic."
},
"duration": {
"type": "integer",
"example": 2,
"description": "Meeting duration."
},
"end_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:42:22Z",
"description": "Meeting end time."
},
"user_name": {
"type": "string",
"example": "Jill Chill",
"description": "User display name."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:40:46Z",
"description": "Meeting start time."
},
"user_email": {
"type": "string",
"example": "jchill@example.com",
"description": "User email."
},
"custom_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "Host Nation",
"maxLength": 64,
"description": "Custom key associated with the user."
},
"value": {
"type": "string",
"example": "US",
"maxLength": 256,
"description": "Value of the custom key associated with the user."
}
}
},
"maxItems": 10,
"description": "Custom keys and values assigned to the meeting."
},
"total_minutes": {
"type": "integer",
"example": 3,
"description": "Number of Webinar minutes. This represents the total amount of Webinar minutes attended by each participant including the host, for a Webinar hosted by the user. For instance if there were one host(named A) and one participant(named B) in a Webinar, the value of total_minutes would be calculated as below:\n\n**total_minutes** = Total Webinar Attendance Minutes of A + Total Webinar Attendance Minutes of B"
},
"tracking_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "Host Nation",
"description": "Tracking fields type."
},
"value": {
"type": "string",
"example": "US",
"description": "Tracking fields value."
}
}
},
"description": "Tracking fields."
},
"participants_count": {
"type": "integer",
"example": 4,
"description": "Number of meeting participants."
}
}
}
ReportsGetWebinarPollReportsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "The webinar ID."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `name` field will return the "Anonymous Attendee" value."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The participant's email address."
},
"last_name": {
"type": "string",
"example": "Chill",
"description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `last_name` field will return the "Anonymous Attendee" value."
},
"first_name": {
"type": "string",
"example": "Jill",
"description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `first_name` field will return the "Anonymous Attendee" value."
},
"question_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "I am wonderful.",
"description": "The user's given answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "The poll question."
},
"date_time": {
"type": "string",
"example": "2022-02-01T12:37:12.660Z",
"description": "The date and time at which the user answered the poll question."
},
"polling_id": {
"type": "string",
"example": "798fGJEWrA",
"description": "The poll's ID."
}
}
},
"description": "Information about the user's questions and answers."
}
}
},
"description": "Information about the webinar questions."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-02-01T12:34:12.660Z",
"description": "The webinar's start time."
}
}
}
ReportsGetWebinarQaReportResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 245603123123,
"description": "Webinar ID in `long` format, represented as int64 data type in JSON. Also known as the webinar number."
},
"uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "Webinar UUID. Each webinar instance will generate its own UUID - after a webinar ends, a new UUID will be generated for the next instance of the webinar. Double-encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "Participant's display name. \n \n\nIf anonymous [Q&A](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) option is enabled and if a participant submits the Q&A without providing their name, the value of the `name` field will be "Anonymous Attendee"."
},
"email": {
"type": "string",
"example": "jchilll@example.com",
"description": "Participant's email. 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."
},
"user_id": {
"type": "string",
"example": "hyROrs0TRCSvwmadI7L13w",
"description": "The user ID of the user who asked the question. This value returns blank for external users."
},
"question_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "fine",
"deprecated": true,
"description": "The given answer. If this is a live answer, the value is 'live answered'.\n**Note:** All answers will be returned together and separated by semicolons. For more detailed answer information, please see the \"answer_details\" field."
},
"question": {
"type": "string",
"example": "how are you",
"description": "Asked question."
},
"create_time": {
"type": "string",
"example": "2022-03-15T07:48:00Z",
"description": "Question creation time."
},
"question_id": {
"type": "string",
"example": "zxU4wOwnlxs",
"description": "Question UUID."
},
"answer_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Paul",
"description": "User display name, including the host or participant. "
},
"type": {
"enum": [
"default",
"host_answered",
"participant_commented"
],
"type": "string",
"default": "default",
"example": "default",
"extensions": {
"x-enum-description": [
"default - default value, does not represent any type",
"host_answered - answer from the host",
"participant_commented - comment from the participant"
]
},
"description": "Type of answer."
},
"email": {
"type": "string",
"example": "paul@example.com",
"description": "Participant's email. 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."
},
"content": {
"type": "string",
"example": "fine",
"maxLength": 1024,
"description": "The answer from the host or the comment from a participant."
},
"user_id": {
"type": "string",
"example": "Cn_5wJ9mRNGyYOmpjVufBQ",
"description": "The user ID of the user who answered the question. This value returns blank for external users."
},
"create_time": {
"type": "string",
"example": "2022-03-15T07:50:00Z",
"description": "Content submission time."
}
}
},
"description": "Array of answers from user."
}
}
},
"description": "Array of questions from the user."
}
}
},
"description": "Array of webinar question objects."
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-03-15T07:40:46Z",
"description": "Webinar start time."
}
}
}
ReportsGetWebinarSurveyReportResponse
{
"type": "object",
"properties": {
"survey_id": {
"type": "string",
"example": "8SFHRTGHAAAiAAAAAiAiAiiAii==",
"description": "The survey's ID"
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2022-02-01T12:34:12.660Z",
"description": "The webinar's start time."
},
"webinar_id": {
"type": "integer",
"format": "int64",
"example": 123456,
"description": "The webinar ID."
},
"survey_name": {
"type": "string",
"example": "Survey of this meeting",
"description": "The name of survey"
},
"webinar_uuid": {
"type": "string",
"example": "4444AAAiAAAAAiAiAiiAii==",
"description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
},
"survey_answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Jill Chill",
"description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `name` field will return the "Anonymous Attendee" value."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "The participant's email address."
},
"last_name": {
"type": "string",
"example": "Chill",
"description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `last_name` field will return the "Anonymous Attendee" value."
},
"first_name": {
"type": "string",
"example": "Jill",
"description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `first_name` field will return the "Anonymous Attendee" value."
},
"answer_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"example": "I am wonderful.",
"description": "The user's given answer."
},
"question": {
"type": "string",
"example": "How are you?",
"description": "The survey question."
},
"date_time": {
"type": "string",
"example": "2022-02-01T12:37:12.660Z",
"description": "The date and time at which the user answered the survey question."
},
"question_id": {
"type": "string",
"example": "798fGJEWrA",
"description": "The question's ID"
}
}
},
"description": "Information about the user's questions and answers."
}
}
},
"description": "Information about the survey questions and answers."
}
}
}
ReportsListSignInSignOutActivitiesResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"example": "2019-09-20T00:00:00Z",
"description": "End date until which you want the activity logs report to be generated"
},
"from": {
"type": "string",
"example": "2019-09-01T00:00:00Z",
"description": "Start date from which you want the activity logs report to be generated."
},
"page_size": {
"type": "integer",
"example": 30,
"description": "The number of records returned with a single API call."
},
"activity_logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"example": "2019-09-15T19:13:41Z",
"description": "Time during which the activity occurred."
},
"type": {
"enum": [
"Sign in",
"Sign out"
],
"type": "string",
"example": "Sign out",
"description": "The type of activity. \n* `Sign in` — Sign in activity by user. \n* `Sign out` — Sign out activity by user."
},
"email": {
"type": "string",
"format": "email",
"example": "jchill@example.com",
"description": "Email address of the user used for the activity."
},
"version": {
"type": "string",
"example": "5.9.1.2581",
"description": "Zoom client version of the user."
},
"ip_address": {
"type": "string",
"example": "192.0.2.1",
"description": "The IP address of the user's device."
},
"client_type": {
"type": "string",
"example": "Browser",
"description": "The client interface type using which the activity was performed."
}
}
},
"description": "Array of activity logs."
},
"next_page_token": {
"type": "string",
"example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
},
"description": "Report object"
}
ReportsListUpcomingEventsReportResponse
{
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "date",
"example": "2022-03-25",
"description": "The report's end date. This value must be within the past six months and cannot exceed a month from the `from` value."
},
"from": {
"type": "string",
"format": "date",
"example": "2022-03-01",
"description": "The report's start date. This value must be within the past six months."
},
"page_size": {
"type": "integer",
"default": 30,
"example": 30,
"maximum": 300,
"description": "The number of records returned in a single API call."
},
"next_page_token": {
"type": "string",
"example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
"description": "The next page token is used to paginate through large result sets. A next page token returns when the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
"upcoming_events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "vawMH9zAQLytjCnQiQXSUg==",
"description": "The event's unique ID."
},
"dept": {
"type": "string",
"example": "HR",
"description": "The event host's department."
},
"topic": {
"type": "string",
"example": "My Meeting",
"description": "The event's topic."
},
"host_id": {
"type": "string",
"example": "Or4-ZeV_SHCOfWRC71O1Fg",
"description": "The event host's ID."
},
"host_name": {
"type": "string",
"example": "chi chi",
"description": "The event host's name."
},
"start_time": {
"type": "string",
"example": "2022-03-15T07:40:46Z",
"description": "The event's start time."
}
}
},
"description": "Information about the upcoming event."
}
}
}