Expand description
The data types sent to and returned from the API client.
Structs§
- Accepted
By - Indicates who accepted the call.
- Account
- 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
Billing Invoices Response - Account
Billing Invoices Response Data - Account
Call Logs Response - Account
Call Logs Response Data - Account Call Logs
- Account
Create Request - 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
Create Response - Account
List Item - Account object in the account list.
- Account
Plan - Account plan object.
- Account
Plan Addon Cancel Request - Account plan object
- Account
Plan Addon Create Request - Zoom Phone Plan Object
- Account
Plan Base Delete Request - Account
Plan Create Request - Account
Plan Create Request AllOf - All of the following types are flattened into one object:
- Account
Plans - Account Plans object.
- Account
Plans Phone Plan Base - Additional phone base plans.
- Account
Plans Response - Account
Plans Response Plan Audio - Additional audio conferencing plan type.
- Account
Plans Response Plan Phone Base - Additional phone base plans.
- Account
Response - Account
Settings - Account
Settings Recording Authentication Update - 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.
- Account
Trusted Domain Response - Accounts
- Activity
Logs - AdHoc
Call Recording - AddAuto
Receptionist Request - AddAuto
Receptionist Response - AddAzr
Location Request - AddAzr
Location Response - AddBatch
Registrants Request - AddBatch
Registrants Response - AddBatch
Webinar Registrants Request - AddBatch
Webinar Registrants Response - AddByoc
Number Request - AddByoc
Number Response - AddCallout
Countries Request - AddCallout
Countries Request Data - AddCallout
Countries Response - AddCommon
Area Phone Request - AddCommon
Area Phone Response - AddExternal
Contact Request - AddInternal
Numbers Request - AddInternal
Numbers Response - AddInternal
Numbers Response Data - AddLocation
Request - AddMembers
Call Queue Request - A maximum of 10 members can be added at a time.
- AddMembers
Call Queue Request Data - AddMembers
Shared Line Group Request - Members can comprise of users on the account as well as common area phones. You can add a maximum of 10 members at once.
- AddMembers
Shared Line Group Request Data - AddPhone
Device Request - AddRole
Members - Add Role Members
- AddRole
Members Request - AddRole
Members Response - AddRoom
Request - AddRoom
Response - AddSetting
Template Request - AddSetting
Template Response - AddUser
Setting Request - AddUser
Setting Request Voice Mail - Update the voicemail setting.
- AddUser
Setting Response - AddUser
Setting Response Voice Mail - Approved
Denied Countries Regions - Approve or block users from specific regions/countries from joining this meeting.
- Archive
- Archiving solution settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.
- Archive
Files - AsDevice
Crc - QoS metrics on screen shares output being received by a participant who joined the meeting via a Cloud Room Connector.
- AsDevice
From Crc - QoS metrics on screen shares by a participant who joined the meeting via a Cloud Room Connector.
- Assign
Calling Plan Request - Assign
Calling Plans Common Area Phone Request - Assign
Calling Plans Common Area Phone Request Data - Assign
Calling Plans Common Area Phone Response - Assign
Calling Plans Common Area Phone Response Data - Assign
Phone Numbers Common Area Request - Assign
Phone Numbers Common Area Response - Assign
Phone Numbers Common Area Response Data - Assign
SipConfig Request - Assign
SipTrunk Numbers Request - Assign
SipTrunks Request - Assign
SipTrunks Request Data - Assign
SipTrunks Response - Assign
SipTrunks Response Data - Assignee
- Assistants
- AtItems
- Attendees
- Attendees
Panelists Reminder Email Notification - Send reminder email to attendees and panelists.
- Audio
Device Crc - QoS metrics on audio received by a participant who joined the meeting via a Cloud Room Connector.
- Audio
Device From Crc - QoS metrics on audio being sent by a participant who joined the meeting via a Cloud Room Connector.
- Authentication
Exception - Authentication
Option - Auto
Call Recording - Basic
- Batch
AddLocations Request - Batch
AddLocations Request Emergency Address - Batch
AddLocations Response - Billing
Contact - Billing Contact object.
- Billing
Reports - Blocked
List - Breakout
Room - Setting to pre-assign breakout rooms.
- Business
Hours - Byoc
- BYOC setting
- Byoc
SipTrunk - Call
Handling - Call
Logs - Call
Queues - Callee
- Callee object contains information of the callee.
- Callee
Qos - Caller
- Caller object contains information of the caller.
- Caller
Qos - Quality of Service object that represents the call quality data of the caller.
- Calling
Plan - Calling
Plans - Callout
Countries - Carrier
- Displayed when the
typerequest parameter isbyoc. - Change
Call Queue Manager Request - Change
Main Company Number Request - Change
Parent Location Request - Change
Zoom Rooms AppVersion Request - Change
ZrLocation Request - Channel
- The channel object represents a Zoom chat channel.
- Channel
Settings - Channels
- Check
InRooms Request - Client
Feedback Details - Client
Feedbacks - Client
Satisfaction - Close
Hours - Cloud
Archived Files - Common
Area Phones - Connect
Operator - Allow callers to press Zero to reach an operator or press One to leave a message, or allow neither of these options.
- Contact
- Billing Contact object.
- Contacts
- Country
- Site country
- CpuUsage
- Create
Batch Polls Request - Create
Batch Polls Response - Create
Call Queue Request - Create
Call Queue Request Members - 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.
- Create
Call Queue Response - Create
Channel Request - Create
Channel Response - Create
Phone Site Request - Create
Role Request - Create
Role Response - Create
Shared Line Group Request - Create
SipPhone Request - Create
Webinar - Base webinar object for sessions.
- Create
Webinar Settings - Create Webinar settings.
- Custom
Attributes - Custom attribute(s) of the user.
- Custom
Hours - Custom
Keys - Custom
Question - Custom Question.
- Custom
Questions - Dashboard
Chat Response - Dashboard
Chat Response AllOf - All of the following types are flattened into one object:
- Dashboard
Chat Response Data - Dashboard
Chat Response Users - Dashboard
Client Feedback Detail Response - Dashboard
Client Feedback Detail Response AllOf - All of the following types are flattened into one object:
- Dashboard
Client Feedback Response - Dashboard
ImResponse - Dashboard
ImResponse AllOf - All of the following types are flattened into one object:
- Dashboard
ImResponse Data - Dashboard
Issue Detail Zoom Room Response - Dashboard
Issue Detail Zoom Room Response AllOf - All of the following types are flattened into one object:
- Dashboard
Issue Zoom Room Response - Dashboard
Issue Zoom Room Response AllOf - All of the following types are flattened into one object:
- Dashboard
Issue Zoom Room Response Data - Dashboard
Meeting Participant Share Response - Dashboard
Meeting Participant Share Response AllOf - All of the following types are flattened into one object:
- Dashboard
Meeting Participant Share Response Participants - Dashboard
Meeting Participants Response - Dashboard
Meeting Participants Response AllOf - All of the following types are flattened into one object:
- Dashboard
Meeting Participants Response Data - Dashboard
Meetings Response - Dashboard
Meetings Response AllOf - All of the following types are flattened into one object:
- Dashboard
Webinar Participants Response - Dashboard
Webinar Participants Response AllOf - All of the following types are flattened into one object:
- Dashboard
Webinar Participants Response Data - Dashboard
Webinars Response - Dashboard
Webinars Response AllOf - All of the following types are flattened into one object:
- Date
Time - DateTime Object.
- Dates
- Dedicated
Dial InNumber - Default
Emergency Address - Delete
Chatbot Message Request - Delete
Chatbot Message Response - Desk
Phone - Contains information on phones or devices provisioned for the user.
- Details
- Device
- The H.323/SIP device object.
- Device
Create Response AllOf - All of the following types are flattened into one object:
- Devices
- Dial
InNumbers - Domains
- Domains
List - List of managed domains.
- Edit
Chatbot Message Request - Edit
Chatbot Message Response - Edit
Message Request - Elin
- The emergency service location’s ELIN (Emergency Location Identification Number).
- Email
Notification - Account Settings: Notification.
- Emergency
Address - Specify emergency address for the account.
- External
Contacts - Feature
- Account Settings: Feature.
- Files
- Follow
UpAbsentees Email Notification - Send follow-up email to absentees.
- Follow
UpAttendees Email Notification - Send follow-up email to attendees.
- Forward
To - Forwarded
By - Indicates where the call was forwarded from.
- Forwarded
To - Indicates who the call was forwarded to.
- GetAccount
Billing Invoice Response - GetAccount
Cloud Recording Response - GetAccount
Cloud Recording Response Meetings - GetBilling
Invoices Reports Response - GetBilling
Report Response - GetCall
LogDetails Response - GetCall
QoSResponse - GetCall
Queue Recordings Response - GetCall
Queue Recordings Response Data - GetCall
Queue Response - GetCall
Queue Response Members - GetCall
Queue Response Members Users - GetChannels
Response - GetChat
Message Response - A chat message object.
- GetChat
Messages Response - Chat message object.
- GetCommon
Area Phone Response - GetCommon
Area Phone Response Numbers - GetCommon
Area Phone Response Policy - GetCommon
Area Phone Response Provision - Provisioning information of the common area phone.
- GetCommon
Area Phone Response Provision SipAccounts - GetDevice
Response - GetDevice
Response Assignee - User to whom the device has been assigned.
- GetGroup
Lock Settings Response - GetGroup
Lock Settings Response InMeeting - GetGroup
Lock Settings Response Recording - GetGroup
Lock Settings Response Schedule Meeting - GetGroup
Lock Settings Response Telephony - GetGroup
Settings Response - GetGroup
Settings Response Email Notification - GetGroup
Settings Response InMeeting - GetGroup
Settings Response Recording - GetGroup
Settings Response Recording Archive - Archiving solution settings. This setting can only be used if you have been granted archiving solution access by the Zoom Support team.
- GetGroup
Settings Response Schedule Meeting - GetGroup
Settings Response Telephony - GetLive
Stream Details Response - GetLocation
Response - GetLocation
Response Elin - The ELIN (Emergency Location Identification Number).
- GetLocation
Response Emergency Address - The emergency location’s address information.
- GetLocation
Response SipGroup - The emergency location’s SIP group information.
- GetLocation
Response Site - The emergency location’s site information.
- GetPhone
Number Details Response - GetPhone
Number Details Response Carrier - GetPhone
Recordings Response - GetPhone
Recordings Response Data - GetPhone
Recordings Response Owner - The owner of the recording.
- GetPlan
Usage Response - GetPlan
Usage Response Base - GetRole
Information Response - GetSetting
Template Response - GetSetting
Template Response Policy - GetSetting
Template Response Profile - GetSetting
Template Response User Settings - GetSetting
Template Response User Settings Desk Phone - GetShared
Line Group Response - GetShared
Line Group Response Members - View current members of the shared line group.
- GetShared
Line Group Response Site - Site assigned to the Shared Line Group.
- GetSite
Response - GetSite
Response Main Auto Receptionist - Main Auto Receptionist for each site.
- GetTracking
Sources Response - GetUser
Contact Response - GetUser
Contacts Response - GetUser
Contacts Response Data - GetZr
Location Profile Response - GetZr
Location Profile Response Basic - GetZr
Location Structure Response - GetZr
Profile Response - GetZr
Profile Response Basic - Global
Dial InNumbers - Group
- Group object.
- Group
Create Request - Group
List - List of Groups.
- Group
Locked Settings Request - Group
Locked Settings Request Recording - Group
Locked Settings Request Schedule Meeting - Group
Member - Group member object.
- Group
Members Create Response - Group
Members Response Data - Group
Response - Groups
- Groups
AllOf - All of the following types are flattened into one object:
- HotDesking
- ImChat
Messages Response - ImChat
Messages Response AllOf - All of the following types are flattened into one object:
- ImChat
Messages Response Data - ImChat
Messages Response Data Type - ImChat
Sessions Response AllOf - All of the following types are flattened into one object:
- ImChat
Sessions Response Data - ImGroup
Create Request - ImGroup
Create Response - ImGroup
Response AllOf - All of the following types are flattened into one object:
- InMeeting
- Account Settings: In Meeting.
- InMeeting
Files - InMeeting
Recording Control Request - Integration
- Account Settings: Integration.
- Internal
Numbers - International
Call - Interpreters
- Invite
Channel Members Request - Invite
Channel Members Response - Invite
Link - Invite Links
- Invite
Links - Invite links response.
- Invite
Links Attendees - Invoice
Items - Invoices
- IpAddress
Access Control - Setting to allow cloud recording access only from specific IP address ranges.
- Issue
Details - Join
Channel Response - Keys
Positions - Language
Interpretation - Line
Subscription - Line subscription.
- List
Account Phone Numbers Response - List
Account Phone Numbers Response Data - List
Archived Files Response - List
Archived Files Response Meetings - List
Archived Files Response Meetings Archive - Information about the archived files.
- List
Blocked Response - List
Byocsip Trunk Response - List
Call Logs Metrics Response - List
Call Logs Metrics Response Data - List
Call Queues Response - List
Call Queues Response Phone Numbers - List
Calling Plans Response - List
Calling Plans Response Data - List
Channel Members Response - List
Channel Members Response Data - List
Common Area Phones Response - List
Digital Signage Content Response - List
External Contacts Response - List
Internal Callout Countries Response - List
Internal Numbers Response - List
Locations Response - List
Locations Response Data - List
Locations Response SipGroup - The emergency service location’s SIP group information.
- List
Locations Response Site - The emergency service location’s site information.
- List
Meeting Satisfaction Response - List
Meeting Templates Response - List
Meeting Templates Response Data - List
Past Meeting Files Response - List
Phone Devices Response - List
Phone Devices Response Data - List
Phone Sites Response - List
Phone Users Response - List
Phone Users Response Calling Plans - List
Phone Users Response Data - List
Setting Templates Response - List
Shared Line Groups Response - List
Shared Line Groups Response Phone Numbers - List
SipGroups Response - List
SipPhones Response - List
SipTrunk Numbers Response - List
SipTrunks Response - List
SipTrunks Response Data - List
Webinar Participants Response - List
Webinar Templates Response - List
Zoom Rooms Response - List
Zoom Rooms Response Data - List
ZrDevices Response - List
ZrLocations Response Data - Listimmessages
Response - Listimmessages
Response Messages - Locations
- LogDetails
- Main
Auto Receptionist - Auto Receptionist for each site.
- Manage
E911 Signage Response - Mark
Message Request - Meeting
Create - Base object for meeting.
- Meeting
Create Response - Meeting
Create Response AllOf - All of the following types are flattened into one object:
- Meeting
Create Settings - Meeting settings.
- Meeting
Create Settings Language Interpretation - Language interpretation settings for meetings.
- Meeting
Create Tracking Fields - Meeting
Info - Meeting object
- Meeting
Info Get - Meeting object.
- Meeting
Invitation - Meeting invitation details.
- Meeting
Live Stream - Meeting live stream.
- Meeting
Live Stream Status - Meeting live stream status.
- Meeting
Live Stream Status Settings - 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 - Meeting metric details.
- Meeting
Password Requirement - Account wide meeting/webinar password requirements.
- Meeting
Poll GetResponse - Meeting
Poll GetResponse AllOf - All of the following types are flattened into one object:
- Meeting
Recording Registrant Create Response - Meeting
Registrant Create Response - Meeting
Registrant Questions - Meeting
Registrant Questions Data - Meeting Registrant Questions
- Meeting
Response - Meeting
Response AllOf - All of the following types are flattened into one object:
- Meeting
Security - Meeting
Security Settings - Meeting
Security Settings Password Requirement - Meeting/webinar passcode requirements.
- Meeting
Settings - Meeting settings.
- Meeting
Status Request - Meeting
Update Request - Meeting
Update Request AllOf - All of the following types are flattened into one object:
- Meetings
- Members
- Messages
- Metrics
- Meeting metric details.
- Multiple
Sites - Network
Switches - Occurrence
- Occurence object. This object is only returned for Recurring Webinars.
- Operation
Logs - Options
- Account options object.
- Outbound
Caller - Outbound Caller Info
- Outbound
Caller Ids - Outgoing
By - Owner
- Pac
- List of PAC accounts.
- PacAccounts
- Pagination
- Pagination Object.
- Pagination
Token - Pagination object.
- Pagination
Token4 ImChat - Pagination object.
- Panelist
- Panelist base object.
- Panelist
List - List of panelists.
- Panelists
- Panelists
AllOf - All of the following types are flattened into one object:
- Params
- Participant
Feedback Response - Participant
Feedback Response Participants - Participant
Qos - Participant QOS.
- Participants
- Password
Requirement - 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.
- Past
Meeting Details Response - Past
Meeting Participants Response - Past
Meeting Participants Response AllOf - All of the following types are flattened into one object:
- Phone
Numbers - Phone
Plan - Phone Plan Object
- Phone
Setting Response - Zoom Account Setting
- Phone
Setting Response Country - Phone
User Call Logs Response - Phone User Call Logs
- Phone
User Recordings Response - Phone User Recordings
- Phone
User Response - Zoom User Profile
- Phone
User Response Numbers - Phone
User Settings Response - Phone User Setting
- Phone
User Settings Response Country - The site’s country.
- Phone
User Voice Mails Response - Phone User Voice Mails
- Phones
- Plan
Audio - Additional audio conferencing plan type.
- Plan
Base - Account base plan object.
- Plan
Number - Plan
Phone - Phone Plan Object
- Plan
Recording - Recording Plan
- Plan
United - Zoom United plan.
- Plan
Webinar - Account plan object.
- Plan
Zoom Rooms - Policy
- A list of the user’s policies. Policies are exceptions to the user’s calling plan restrictions.
- Poll
- Poll
- Polls
- Post
Phone SipTrunk Request - Primary
Number - 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.
- Profile
- Properties
- Provision
- Provisioning information of a device.
- Provision
Template - QoSPhone
- Quality of Service object.
- Qos
- QosAudio
- Quality of Service object.
- Question
Answer - Q&A for webinar.
- Question
Details - Questions
- React
Message Request - Reactions
- Recording
- Account Settings: Recording.
- Recording
Data - Recording file object.
- Recording
Files - Recording
GetResponse - Recording
GetResponse AllOf - All of the following types are flattened into one object:
- Recording
Password Requirement - This object represents the minimum password requirements set for recordings via Account Recording Settings.
- Recording
Registrant Questions - Recording
Registrant Questions Custom - Recording
Registrant Questions Data - Recording Registrant Questions
- Recording
Registrant Status - Registrant Status
- Recording
Separate Audio - The recording file object.
- Recording
Settings - Recording
Status Update Body Request - Recording
Storage Location - Recordings
- Recurrence
- Recurrence object. Use this object only for a meeting with type
8i.e., a recurring meeting with fixed time. - Recurrence
Webinar - Recurrence object. Use this object only for a webinar of type
9i.e., a recurring webinar with fixed time. - Registrant
- Registrant base object.
- Registrant
Status - Report
Cloud Recording Response - Report
Cloud Recording Response AllOf - All of the following types are flattened into one object:
- Report
Daily Response - Report
Meeting Details Response - Report
Meeting Participants Response - Report
Meeting Participants Response AllOf - All of the following types are flattened into one object:
- Report
Meeting Participants Response Data - Report
Meeting Polls Response - Report
Meeting Polls Response Questions - Report
Meetings Response - Report
Meetings Response AllOf - All of the following types are flattened into one object:
- Report
Operation Logs Response - Report
Operation Logs Response AllOf - All of the following types are flattened into one object:
- Report
Sign InOut Activities Response - Report object
- Report
Webinar Participants Response - Report
Webinar Participants Response AllOf - All of the following types are flattened into one object:
- Report
Webinar Participants Response Data - Report
Webinar QaResponse - Report
Webinar QaResponse Questions - Report
Webinar QaResponse Questions Question Details - Role
Members List - List of a Role Members
- Rooms
- Schedule
Meeting - Account Settings: Schedule Meeting.
- Schedulers
- Search
Company Contacts Response - Security
- Security settings of an Account.
- Senda
Chat Message Request - Sendchatbot
Request - Sendimmessages
Request - Sending
- Session
- Base object for sessions.
- Session
Update - Base object for sessions.
- Session
Update Tracking Fields - Session
Webinar - Base webinar object for sessions.
- Session
Webinar Update - Base webinar object for sessions.
- Session
Webinar Update Settings AllOf - All of the following types are flattened into one object:
- Sessions
- SetUp
Account Request - Settings
- Settings
AllOf - All of the following types are flattened into one object:
- Settings
Data - Settings
Update Telephony - Shared
Line - Return additional provisioning information with generic device SIP credentials.
- Shared
Line Groups - Short
Extension - Short extension of the phone site.
- Show
Device IpCall Log - SipAccounts
- SipGroup
- Displayed when the
typerequest parameter isbyoc. - SipGroups
- SipTrunk
- The SIP trunk group.
- SipTrunks
- Site
- Sites
- Sms
- SubAccount
Privileges - This field will only be displayed to accounts that are enrolled in a partner plan and follow the master accounts and sub accounts structure.
- Switch
User Account Request - Telephony
- Account Settings: Telephony.
- Telephony
Regions - Indicates where most of the participants call into or call from duriing a meeting.
- Templates
- Tracking
Field - Tracking Field
- Tracking
Fields - Tracking
Sources - Trackingfield
GetResponse AllOf - All of the following types are flattened into one object:
- Tsp
- Account Settings: TSP.
- TspAccount
- TSP account of the user.
- TspAccount
Data - TSP account.
- TspAccounts
- List of TSP accounts.
- TspAccounts
List - List of TSP accounts.
- TspGlobal
Dial In - TspResponse
- TspResponse
Dial InNumbers - TspUpdate
Request - Update
Account Settings - Update
Account Settings Telephony - Account Settings Update: Telephony.
- Update
Account Settings Telephony Regions - Indicates where most of the participants call into or call from duriing a meeting.
- Update
Auto Receptionist Request - Update
Blocked List Request - Update
Call Queue Request - Update
Common Area Phone Request - Update
Common Area Phone Request Policy - Update
Device Request - Update
External Contact Request - Update
Group Member Request - Update
Group Settings Request - Update
Group Settings Request InMeeting - Update
Group Settings Request Schedule Meeting - Update
Group Settings Request Telephony - Update
Location Request - Update
Phone Number Details Request - Update
Phone Settings Request - Update
Phone Settings Request Byoc - Only master account owners can use this MA API to enable BYOC(Bring your own carrier) option for a sub account.
- Update
Phone SipTrunk Request - Update
Presence Status Request Data - Update
Role Request - Update
Role Request SubAccount Privileges - This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.
- Update
Room Profile Request - Update
Room Profile Request Basic - Update
Setting Template Request - Update
Setting Template Request Policy - Update
Setting Template Request Policy Auto Call Recording - Update
Shared Line Group Request - Update
SipPhone Request - Update
Site Details Request - Update
User Profile Request - Update
User Profile Request Policy - A list of the user’s policies.
- Update
User Setting Request - Update
User Setting Request Voice Mail - Update the voicemail setting.
- Update
ZrAcc Profile Request - Upload
VbRequest - User
- The user object represents a specific user on Zoom.
- User
Assistants List - List of user’s assistants.
- User
Create Request - User
Create Response - User
Email Response - User
Info - User
PaCs Response - User
Password Request - User
Permissions - UserQos
- User
Response - User
Response AllOf - All of the following types are flattened into one object:
- User
Response Custom Attributes - Custom attribute(s) that have been assigned to the user.
- User
Response Phone Numbers - User
Schedulers List - List of user’s schedulers.
- User
Settings - User
Settings Feature - User
Settings InMeeting - User
Settings Meeting - User
Settings Meeting Password Requirement - Account wide meeting/webinar passcode requirements.
- User
Settings Notification - User
Settings Recording - User
Settings Recording Password Requirement - This object represents the minimum passcode requirements set for recordings via Account Recording Settings.
- User
Settings Telephony - User
Settings Tsp - Account Settings: TSP.
- User
Settings Update - User
Settings Update Feature - User
Status Request - The action.
- User
TsPs Response - User
Update - The user update object represents a user on Zoom.
- User
Vanity Name Response - User
ZakResponse - Users
- Users
Response - Users
Response Custom Attributes - Users
Response Data - Video
Device Crc - QoS metrics on video output received by a participant who joined the meeting via a Cloud Room Connector.
- Video
Device From Crc - QoS metrics on video input being sent from a Cloud Room Connector used by the participant to join the meeting.
- Virtual
Background Settings - Settings to manage virtual background.
- Voice
Mail - Shared voicemail access assigned to user.
- Voice
Mails - Voicemail
- Waiting
Room Settings - Specify the settings to be applied if waiting room is enabled.
- Webinar
Create Response - Webinar
Create Response AllOf - All of the following types are flattened into one object:
- Webinar
Info - Webinar object.
- Webinar
Live Stream Status - Webinar live stream status.
- Webinar
Live Stream Status Settings - Update the live stream session’s settings. You can only update settings for a stopped live stream.
- Webinar
Panelist - Webinar panelist.
- Webinar
Panelist Create Response - Webinar
Registrant Create Response - Webinar
Registrant Questions - Webinar Registrant Questions
- Webinar
Response - Webinar
Response AllOf - All of the following types are flattened into one object:
- Webinar
Settings - Webinar settings.
- Webinar
Status Request - Webinars
- Webinar metric details.
- Zoom
Room - Zoom room.
- Zoom
Rooms - Account Settings: Zoom Rooms.
Enums§
- Account
Plan Addon Cancel Request Action - The action that needs to be taken for this sub account. Value must be set to “cancel”.
- Account
Plan Addon Create Request OneOf - All of the following types:
- Account
Plans Response Plan Base Status - Status of the plan.
- Account
Settings Recording Authentication Update Option Action - Account
Settings Recording Authentication Update Option Type - Account
Settings Response OneOf - All of the following types:
- Account
Settings Update Option - Account
Settings Update Request OneOf - All of the following types:
- Action
- Update the status of a livestream.
- AddSetting
Template Request Type - The type of template. Values include
user,group,autoReceptionist,commonarea, orinterop. - Answer
Questions - Indicate whether you want attendees to be able to view answered questions only or view all questions.
- Audio
- Determine how participants can join the audio portion of the meeting.
both- Both Telephony and VoIP.telephony- Telephony only.voip- VoIP only. - Audio
Quality - Audio quality of the participant.
- Audio
Type - 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. - Auto
Recording - Automatic recording:
local- Record on local.cloud- Record on cloud.none- Disabled. - Call
Type - The type of call:
*
voip(Voice over IP) *pstn(Public Switched Telephone Network) *tollfree*international*contactCenter - Category
Type - 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 - Change
Zoom Rooms AppVersion Request Action - Specify one of the following values for this field:
- Dashboard
Meeting Participants Include Fields - Provide
registrant_idas 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 forlivemeeting types. - Dashboard
Meeting Participants Response Device - The type of device the participant used to join the meeting:
- Dashboard
Meeting Participants Response Status - Indicates whether the participant is in the waiting room or in the meeting.
- Dashboard
Meetings Type - 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. - Dashboard
Webinars Type - The webinar type.
- Device
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 - Direction
- The direction of the call. Values:
inboundoroutbound. - Encryption
- Device encryption:
auto- auto.yes- yes.no- no. - Encryption
Type - 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. - Entry
Exit Chime - Play sound when participants join or leave.
host- Heard by host only.all- Heard by host and all attendees.none- Disable. - Extension
Type - The type of assignee to whom the number is assigned. The value can be one of the following:
user
callQueue
autoReceptionist
commonAreaPhone - Field
Name - Field name of the question.
- File
Type - The archived file’s file type:
- GetAccount
Cloud Recording Response Meetings Files File Type - The recording file type. The value of this field could be one of the following:
- GetAccount
Cloud Recording Response Meetings Files Status - The status of the recording, either
completedorprocessing. - GetAccount
Cloud Recording Response Meetings Files Type - The recording type. The value of this field can be one of the following:
- GetChat
Messages Response Status - This field indicates whether a message is an original message(unedited), an edited message or a deleted message.
- GetCommon
Area Phone Response Policy HotDesking Status - Allow Hot Desking feature to current device.
- GetDevice
Response Provision Type - Provisioning type. The value can be one of the following:
- GetGroup
Lock Settings Response OneOf - All of the following types:
- GetGroup
Settings Response OneOf - All of the following types:
- GetPhone
Recordings Response Owner Type - The owner type:
userorcall queue. - GetSetting
Template Response Type - The type of template being queried. Values:
user,group,auto receptionistcommon area,zr,interop. - GetSetting
Template Response User Settings Call Handling Business Hours Connect Operator Type - Values:
1-user,
2-callQueue,
3-autoReceptionist,
4-commonAreaPhone,
5-zoomRoom,
7-sharedLineGroup - Group
Locked Settings Request OneOf - All of the following types:
- Hold
Music - The value of this field can be either
defaultordisable. - ImChat
Sessions Response Type - IM chat session type.
- ImGroup
Create Request 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. - Include
Fields - Set the value of this field to “tracking_fields” if you would like to include tracking fields of each meeting in the response.
- Label
- The label to add to the user’s phone number. You can only add one label to the user’s phone number:
- Languages
- Specify the language in which this phone number should be displayed. Currently, the only supported languages are
en-GB,en-US,de-DE. - Level
- 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. - List
Account Phone Numbers Response Status - Status of the number.
- List
Account Phone Numbers Type - 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. - List
Archived Files Query Date Type - The query date type for the
fromandtoparameters. - List
Phone Devices Response Status - Status of the device. The value is either
onlineoroffline. - List
Phone Devices Type - State of the device. The value should be either
assignedto list devices that have been assigned to user(s) orunassignedto list devices that have not yet been assigned to any user in the Zoom account. - List
Setting Templates Response Type - Template type.
The value of this field can be one of the following: - List
Zoom Rooms Status - The status of the Zoom Room.
- List
Zoom Rooms Type - Type of the Zoom Rooms.
- List
ZrDevices Response Status - Status of the device. The value can be either
OnlineorOffline. - List
ZrLocations Response Type - The type of location. The value can be one of the following:
country,states,city,campus,building,floor. - Login
Type - The user’s login method:
- Match
Type - 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 thephone_numberfield is blocked.
prefix: Indicates that all numbers starting with prefix that is shown in thephone_numberfield are blocked. - Meeting
Poll Create Response Status - Status of the Meeting Poll:
notstart- Poll not startedstarted- Poll startedended- Poll endedsharing- Sharing poll results - Meeting
Registrant Questions Custom Type - Type of the question being asked.
- Meeting
Registrants Status - The registrant status:
pending- Registrant’s status is pending.approved- Registrant’s status is approved.denied- Registrant’s status is denied. - Meeting
Status Request Action end- End a meeting.
recover- Recover a deleted meeting.- Meetings
Type - 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. - Method
- 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 theapproved_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 thedenied_list - Network
Type - The participant’s network type:
- Option
Data - Use the following options to filter the results of the account’s information:
- PayMode
- Payee:
master- master account holder pays.sub- Sub account holder pays. - Phone
User Call Logs Response Forwarded ByExtension Type - Phone
User Call Logs Type - Phone
User Voice Mails Response Status - Status of the voice mail. Can be either ‘read’ or ‘unread’
- Phone
User Voice Mails Status - Status of the voice mail
- Plan
Recording Status - Status of additional Cloud Recording plan.
- Poll
Questions Type - Poll Question & Answer type:
single- Single choicemutliple- Multiple choice - Presence
Status - 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 - Protocol
- Device protocol:
H.323- H.323.SIP- SIP. - Quality
- Feedback submitted by the participant.
- Query
Date Type - Date types:
start_time- Query by call start time.end_time- Query by call end time. - React
Message Request Action - The action to perform with the message:
- Recording
Calls - Values: inbound, outbound, both.
- Recording
Delete Action - The recording delete actions:
trash- Move recording to trash.delete- Delete recording permanently. - Recording
Registrant Questions Custom Type - The type of registration question and answers.
- Recording
Registrant Questions Field Name - Field name.
- Recording
Status - The recording status.
- Recording
Status Update Body Request Action - Recording
Type - The archived file’s recording type:
- Registrant
Status Action - Registrant Status:
approve- Approve registrant.cancel- Cancel previously approved registrant’s registration.deny- Deny registrant. - Report
Meetings Type - The meeting types:
past- Past meetings.pastOne- Past one user meetings. - Report
Users Type - Active or inactive hosts.
active- Active hosts.inactive- Inactive hosts. - Require
Password PmiMeetings - 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
- Result of the call:
call_connected|recorded|no_answer. - Role
- The role of the member. The value can be one of these:
owner,admin,member. - Setting
Type - 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. - Share
Recording - Determine how the meeting recording is shared.
- Sign
InWith TwoFactor Auth - 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 thesign_in_with_two_factor_auth_groupsfield.
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 thesign_in_with_two_factor_auth_rolesfield. - Source
- Source of phone number.
- Status
- Meeting status
- Time
Type - Enables you to sort call logs by start or end time. Choose the sort time value. Values include
startTimeorendTime. - Transport
Protocol - Protocols supported by the SIP provider.
The value must be eitherUDP,TCP,TLS,AUTO. - TspAccounts
List Dial InNumbers Type - Dial-in number types:
toll- Toll number.tollfree-Toll free number.
media_link- Media link. - TspBridge
- Telephony bridge
- Type
- Type of number.
- Update
Group Member Request Action - The action to perform:
- Update
Group Settings Option - Update
Group Settings Request OneOf - All of the following types:
- Update
Presence Status Request - Presence status of the user. The value can be set to one of the following:
- User
Create Request Action - 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 thestart_urlandjoin_urlrespectively. 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. - User
Delete Action - Delete action options:
disassociate- Disassociate a user.delete- Permanently delete a user.
Note: To delete pending user in the account, usedisassociate - User
Settings Response OneOf - All of the following types:
- User
Settings Update Option - User
Settings Update Request OneOf - All of the following types:
- User
Status Request Action - The action types:
activate- Activate a deactivated user.deactivate- Deactivate a user. - User
Token Type - 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. - Users
Include Fields - Use this parameter to display one of the following attributes in the API call’s response:
- Users
Status - The user’s status:
- Webinar
Status Request Action - Weekly
Days - This field is required if you’re scheduling a recurring meeting of type
2to state which day(s) of the week the meeting should repeat.
The value for this field could be a number between1to7in 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. - WhoCan
Share Screen - 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.