Expand description
The data types sent to and returned from the API client.
Structs
Indicates who accepted the call.
The account object represents an account on Zoom. The account owner is the user who created the account or had an account created for them. You can read more about the Zoom account structure here.
Account Call Logs
The account object represents an account on Zoom. The account owner is the user who created the account or had an account created for them. You can read more about the Zoom account structure here.
Account object in the account list.
Account plan object.
Account plan object
Zoom Phone Plan Object
All of the following types are flattened into one object:
Account Plans object.
Additional phone base plans.
Additional audio conferencing plan type.
Additional phone base plans.
Only authenticated users can view cloud recordings The viewers need to authenticate prior to viewing the cloud recordings, hosts can choose one of the authentication methods when sharing a cloud recording.
A maximum of 10 members can be added at a time.
Members can comprise of users on the account as well as common area phones. You can add a maximum of 10 members at once.
Add Role Members
Update the voicemail setting.
Approve or block users from specific regions/countries from joining this meeting.
Archiving solution settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.
QoS metrics on screen shares output being received by a participant who joined the meeting via a Cloud Room Connector.
QoS metrics on screen shares by a participant who joined the meeting via a Cloud Room Connector.
Send reminder email to attendees and panelists.
QoS metrics on audio received by a participant who joined the meeting via a Cloud Room Connector.
QoS metrics on audio being sent by a participant who joined the meeting via a Cloud Room Connector.
Billing Contact object.
Setting to pre-assign breakout rooms.
BYOC setting
Callee object contains information of the callee.
Caller object contains information of the caller.
Quality of Service object that represents the call quality data of the caller.
Displayed when the type request parameter is byoc.
Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.
Billing Contact object.
Site country
A list of one or more phone users to be included in the call queue. Provide either users or common area phone(s). Provide at least one user in the users object.
Base webinar object for sessions.
Create Webinar settings.
Custom attribute(s) of the user.
Custom Question.
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
DateTime Object.
Contains information on phones or devices provisioned for the user.
The H.323/SIP device object.
All of the following types are flattened into one object:
List of managed domains.
The emergency service location’s ELIN (Emergency Location Identification Number).
Account Settings: Notification.
Specify emergency address for the account.
Account Settings: Feature.
Send follow-up email to absentees.
Send follow-up email to attendees.
Indicates where the call was forwarded from.
Indicates who the call was forwarded to.
A chat message object.
Chat message object.
Provisioning information of the common area phone.
User to whom the device has been assigned.
Archiving solution settings. This setting can only be used if you have been granted archiving solution access by the Zoom Support team.
The ELIN (Emergency Location Identification Number).
The emergency location’s address information.
The emergency location’s SIP group information.
The emergency location’s site information.
The owner of the recording.
View current members of the shared line group.
Site assigned to the Shared Line Group.
Main Auto Receptionist for each site.
Group object.
List of Groups.
Group member object.
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
Account Settings: In Meeting.
Account Settings: Integration.
Invite Links
Invite links response.
Setting to allow cloud recording access only from specific IP address ranges.
Line subscription.
Information about the archived files.
The emergency service location’s SIP group information.
The emergency service location’s site information.
Auto Receptionist for each site.
Base object for meeting.
All of the following types are flattened into one object:
Meeting settings.
Language interpretation settings for meetings.
Meeting object
Meeting object.
Meeting invitation details.
Meeting live stream.
Meeting live stream status.
Update the settings of a live streaming session. The settings can only be updated for a live stream that has been stopped. You can not update the settings of an ongoing live stream.
Meeting metric details.
Account wide meeting/webinar password requirements.
All of the following types are flattened into one object:
Meeting Registrant Questions
All of the following types are flattened into one object:
Meeting/webinar passcode requirements.
Meeting settings.
All of the following types are flattened into one object:
Meeting metric details.
Occurence object. This object is only returned for Recurring Webinars.
Account options object.
Outbound Caller Info
List of PAC accounts.
Pagination Object.
Pagination object.
Pagination object.
Panelist base object.
List of panelists.
All of the following types are flattened into one object:
Participant QOS.
This object refers to the enhanced password rules that allows Zoom account admins and owners to apply extra requiremets to the users’ Zoom login password.
All of the following types are flattened into one object:
Phone Plan Object
Zoom Account Setting
Phone User Call Logs
Phone User Recordings
Zoom User Profile
Phone User Setting
The site’s country.
Phone User Voice Mails
Account base plan object.
Phone Plan Object
Recording Plan
Zoom United plan.
Account plan object.
A list of the user’s policies. Policies are exceptions to the user’s calling plan restrictions.
Poll
If you have multiple direct phone numbers assigned to the shared line group, select a number from those numbers as the primary number. The primary number shares the same line as the extension number. This means if a caller is routed to the shared line group through an auto receptionist, the line associated with the primary number will be used. A pending number cannot be used as a Primary Number.
Provisioning information of a device.
Quality of Service object.
Quality of Service object.
Q&A for webinar.
Account Settings: Recording.
Recording file object.
All of the following types are flattened into one object:
This object represents the minimum password requirements set for recordings via Account Recording Settings.
Recording Registrant Questions
Registrant Status
The recording file object.
Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.
Recurrence object. Use this object only for a webinar of type 9 i.e., a recurring webinar with fixed time.
Registrant base object.
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
All of the following types are flattened into one object:
Report object
All of the following types are flattened into one object:
List of a Role Members
Account Settings: Schedule Meeting.
Security settings of an Account.
Base object for sessions.
Base object for sessions.
Base webinar object for sessions.
Base webinar object for sessions.
All of the following types are flattened into one object:
All of the following types are flattened into one object:
Return additional provisioning information with generic device SIP credentials.
Short extension of the phone site.
Displayed when the type request parameter is byoc.
The SIP trunk group.
This field will only be displayed to accounts that are enrolled in a partner plan and follow the master accounts and sub accounts structure.
Account Settings: Telephony.
Indicates where most of the participants call into or call from duriing a meeting.
Tracking Field
All of the following types are flattened into one object:
Account Settings: TSP.
TSP account of the user.
TSP account.
List of TSP accounts.
List of TSP accounts.
Account Settings Update: Telephony.
Indicates where most of the participants call into or call from duriing a meeting.
Only master account owners can use this MA API to enable BYOC(Bring your own carrier) option for a sub account.
This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.
A list of the user’s policies.
Update the voicemail setting.
The user object represents a specific user on Zoom.
List of user’s assistants.
All of the following types are flattened into one object:
Custom attribute(s) that have been assigned to the user.
List of user’s schedulers.
Account wide meeting/webinar passcode requirements.
This object represents the minimum passcode requirements set for recordings via Account Recording Settings.
Account Settings: TSP.
The action.
The user update object represents a user on Zoom.
QoS metrics on video output received by a participant who joined the meeting via a Cloud Room Connector.
QoS metrics on video input being sent from a Cloud Room Connector used by the participant to join the meeting.
Settings to manage virtual background.
Shared voicemail access assigned to user.
Specify the settings to be applied if waiting room is enabled.
All of the following types are flattened into one object:
Webinar object.
Webinar live stream status.
Update the live stream session’s settings. You can only update settings for a stopped live stream.
Webinar panelist.
Webinar Registrant Questions
All of the following types are flattened into one object:
Webinar settings.
Webinar metric details.
Zoom room.
Account Settings: Zoom Rooms.
Enums
The action that needs to be taken for this sub account. Value must be set to “cancel”.
All of the following types:
Status of the plan.
All of the following types:
All of the following types:
Update the status of a livestream.
The type of template. Values include user, group, autoReceptionist, commonarea, or interop.
Indicate whether you want attendees to be able to view answered questions only or view all questions.
Determine how participants can join the audio portion of the meeting.both - Both Telephony and VoIP.telephony - Telephony only.voip - VoIP only.
Audio quality of the participant.
Determine how participants can join the audio portion of the meeting.both - Telephony and VoIP.telephony - Audio PSTN telephony only.voip - VoIP only.thirdParty - 3rd party audio conference.
Automatic recording:local - Record on local.cloud - Record on cloud.none - Disabled.
The type of call:
*voip (Voice over IP)
*pstn (Public Switched Telephone Network)
*tollfree
*international
*contactCenter
Optional
Filter your response by a category type to see reports for a specific category.
The value for this field can be one of the following:
alluseruser_settingsaccountbillingimrecordingphone_contactswebinarsub_accountrolezoom_rooms
Specify one of the following values for this field:
Provide registrant_id as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a meeting registrant. This is not supported for live meeting types.
The type of device the participant used to join the meeting:
Indicates whether the participant is in the waiting room or in the meeting.
Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:
past - Meeting that already occurred in the specified date range.pastOne - Past meetings that were attended by only one user. live - Live meetings.
The webinar type.
Type of the device. The value of this field can be one of the following:Zoom Rooms Computer,
Controller, Scheduling Display, Zoom Rooms Control System, Companion Whiteboard
The direction of the call. Values: inbound or outbound.
Device encryption:auto - auto.yes - yes.no - no.
Choose between enhanced encryption and end-to-end encryption when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be automatically disabled.
The value of this field can be one of the following:
enhanced_encryption: Enhanced encryption. Encryption is stored in the cloud if you enable this option.
Play sound when participants join or leave.host - Heard by host only.all - Heard by host and all attendees.none - Disable.
The type of assignee to whom the number is assigned. The value can be one of the following:
user
callQueue
autoReceptionist
commonAreaPhone
Field name of the question.
The archived file’s file type:
The recording file type. The value of this field could be one of the following:
The status of the recording, either completed or processing.
The recording type. The value of this field can be one of the following:
This field indicates whether a message is an original message(unedited), an edited message or a deleted message.
Allow Hot Desking feature to current device.
Provisioning type. The value can be one of the following:
All of the following types:
All of the following types:
The owner type: user or call queue.
The type of template being queried. Values: user, group, auto receptionist common area,zr, interop.
Values:
1-user,
2-callQueue,
3-autoReceptionist,
4-commonAreaPhone,
5-zoomRoom,
7-sharedLineGroup
All of the following types:
The value of this field can be either default or disable.
IM chat session type.
IM Group types:normal - Only members can see automatically see the other members of this group. Other people can search for members within this group. shared - Everyone under an account can see the group members automatically.restricted - Nobody can see the group or search for members except the members in the group.
Set the value of this field to “tracking_fields” if you would like to include tracking fields of each meeting in the response.
The label to add to the user’s phone number. You can only add one label to the user’s phone number:
Specify the language in which this phone number should be displayed. Currently, the only supported languages are en-GB, en-US, de-DE.
Level of the user. The value can be one of the following:
manager: A call queue manager has the privilege to change call queue settings, policy settings and manage recordings and voicemail inbox. There can only be one manager for each call queue.
user: Regular user without the privileges of a manager.
Status of the number.
Query response by number assignment. The value can be one of the following:
assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. unassigned: The number is not assigned to anyone.
all: Include both assigned and unassigned numbers in the response.
byoc: Include Bring Your Own Carrier (BYOC) numbers only in the response.
The query date type for the from and to parameters.
Status of the device. The value is either online or offline.
State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.
Template type.
The value of this field can be one of the following:
The status of the Zoom Room.
Type of the Zoom Rooms.
Status of the device. The value can be either Online or Offline.
The type of location. The value can be one of the following:
country, states, city, campus, building, floor.
The user’s login method:
Indicates the match type for the blocked list. The values can be one of the following:
phoneNumber: Indicates that only a specific phone number that is shown in the phone_number field is blocked.
prefix: Indicates that all numbers starting with prefix that is shown in the phone_number field are blocked.
Status of the Meeting Poll:notstart - Poll not startedstarted - Poll startedended - Poll endedsharing - Sharing poll results
Type of the question being asked.
The registrant status:pending - Registrant’s status is pending.approved - Registrant’s status is approved.denied - Registrant’s status is denied.
end - End a meeting.
recover - Recover a deleted meeting.
The meeting types: scheduled - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of “Previous Meetings” and “Upcoming Meetings” displayed in the user’s Meetings page on the Zoom Web Portal.live - All the ongoing meetings.upcoming - All upcoming meetings including live meetings.
Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting.
approve: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the approved_list.
deny: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the denied_list
The participant’s network type:
Use the following options to filter the results of the account’s information:
Payee:master - master account holder pays.sub - Sub account holder pays.
Status of the voice mail. Can be either ‘read’ or ‘unread’
Status of the voice mail
Status of additional Cloud Recording plan.
Poll Question & Answer type:single - Single choicemutliple - Multiple choice
Presence status of the contact in Zoom Client. The value of this field can be one of the following:
Do_Not_Disturb
away
Available
Offline
Device protocol:H.323 - H.323.SIP - SIP.
Feedback submitted by the participant.
Date types:start_time - Query by call start time.end_time - Query by call end time.
The action to perform with the message:
Values: inbound, outbound, both.
The recording delete actions:trash - Move recording to trash.delete - Delete recording permanently.
The type of registration question and answers.
Field name.
The recording status.
The archived file’s recording type:
Registrant Status:approve - Approve registrant.cancel - Cancel previously approved registrant’s registration.deny - Deny registrant.
The meeting types: past - Past meetings.pastOne - Past one user meetings.
Active or inactive hosts.active - Active hosts. inactive - Inactive hosts.
Require a password for a meeting held using Personal Meeting ID (PMI) This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
Result of the call: call_connected | recorded | no_answer.
The role of the member. The value can be one of these: owner, admin, member.
The type of setting that you would like to retrieve.
alert: Alert Settings applied on the Zoom Rooms Account.
meeting: Meeting settings of the Zoom Rooms Account.
signage: View digital signage settings of the Zoom Rooms Account.
Determine how the meeting recording is shared.
Settings for 2FA( two factor authentication ). The value can be one of the following:
all: Two factor authentication will be enabled for all users in the account.
none: Two factor authentication is disabled.
group: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the sign_in_with_two_factor_auth_groups field.
role: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the
sign_in_with_two_factor_auth_roles field.
Source of phone number.
Meeting status
Enables you to sort call logs by start or end time. Choose the sort time value. Values include startTime or endTime.
Protocols supported by the SIP provider.
The value must be either UDP, TCP, TLS, AUTO.
Dial-in number types:toll - Toll number.tollfree -Toll free number.
media_link - Media link.
Telephony bridge
Type of number.
The action to perform:
All of the following types:
Presence status of the user. The value can be set to one of the following:
Specify how to create the new user: create - User will get an email sent from Zoom. There is a confirmation link in this email. The user will then need to use the link to activate their Zoom account. The user can then set or change their password.autoCreate - This action is provided for the enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain.custCreate - Users created via this option do not have passwords and will not have the ability to log into the Zoom Web Portal or the Zoom Client. These users can still host and join meetings using the start_url and join_url respectively. To use this option, you must contact the ISV Platform Sales team at isv@zoom.us.ssoCreate - This action is provided for the enabled “Pre-provisioning SSO User” option. A user created in this way has no password. If not a basic user, a personal vanity URL using the user name (no domain) of the provisioning email will be generated. If the user name or PMI is invalid or occupied, it will use a random number or random personal vanity URL.
Delete action options:disassociate - Disassociate a user.delete- Permanently delete a user.
Note: To delete pending user in the account, use disassociate
All of the following types:
All of the following types:
The action types:activate - Activate a deactivated user.deactivate - Deactivate a user.
User token types:token - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.zak - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
Use this parameter to display one of the following attributes in the API call’s response:
The user’s status:
This field is required if you’re scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.
The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.
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 the value of this field.
Indicates who can share their screen or content during meetings. The value can be one of the following:
host: Only host can share the screen.
all: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.