You can wire the Zoom node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.
Credentials
Connect Zoom under Credentials in the node settings. See Connecting credentials for the general flow.OAuth
Sign in with your Zoom account when prompted; no keys to copy. Get your credentials here. NoClick requests the following permissions:meeting:read:meetingmeeting:write:meetingmeeting:read:list_meetingsmeeting:read:list_registrantsmeeting:write:registrantmeeting:read:invitationmeeting:read:past_meetingmeeting:read:list_past_participantswebinar:read:webinarwebinar:write:webinarwebinar:read:list_webinarswebinar:read:list_registrantswebinar:write:registrantuser:read:useruser:write:useruser:read:list_userscloud_recording:read:list_user_recordingscloud_recording:read:list_account_recordingscloud_recording:read:list_recording_filescloud_recording:delete:meeting_recordingsphone:read:list_call_logschat_message:write:message
Server to server
Enter the values manually when creating the credential. Create a Server-to-Server OAuth app at marketplace.zoom.us (Develop -> Build App -> Server-to-Server OAuth). Copy the Account ID, Client ID, and Client Secret, and add the scopes your operations need (meeting, webinar, user, recording, phone, chat). Get your credentials here.Operations
Accounts
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Sub Account | create_sub_account | Create a sub account under a master account. | |
| Create Tracking Field | create_tracking_field | Create a new tracking field on the account. | |
| Delete Tracking Field | delete_tracking_field | Delete a tracking field by ID. | |
| Disassociate Sub Account | disassociate_sub_account | Disassociate a sub account from its master account. | |
| Get Account Lock Settings | get_account_lock_settings | Get an account’s locked settings. Use ‘me’ for the master/regular account. | |
| Get Account Managed Domains | get_account_managed_domains | Get an account’s managed domains. Use ‘me’ for the master/regular account. | |
| Get Account Settings | get_account_settings | Get an account’s settings. Use ‘me’ for the master/regular account. | |
| Get Account Trusted Domains | get_account_trusted_domains | Get an account’s trusted domains. Use ‘me’ for the master/regular account. | |
| Get Sub Account | get_sub_account | Get details of a sub account listed under a master account. | |
| Get Tracking Field | get_tracking_field | Get details of a single tracking field by ID. | |
| List Sub Accounts | list_sub_accounts | List all sub accounts created by a master account. | |
| List Tracking Fields | list_tracking_fields | List all the tracking fields on the account. | |
| Update Account Lock Settings | update_account_lock_settings | Update an account’s locked settings. Use ‘me’ for the master/regular account. | |
| Update Account Options | update_account_options | Update a sub account’s options under the master account. | |
| Update Account Owner | update_account_owner | Change the owner of a sub account to another user on that account. | |
| Update Account Settings | update_account_settings | Update an account’s settings. Use ‘me’ for the master/regular account. | |
| Update Tracking Field | update_tracking_field | Update an existing tracking field by ID. |
AI services
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cancel Scribe Job | ai_cancel_scribe_job | Cancel a Zoom Scribe batch job. | |
| Cancel Summarizer Job | ai_cancel_summarizer_job | Cancel a Zoom Summarizer batch job. | |
| Cancel Translator Job | ai_cancel_translator_job | Cancel a Zoom Translator batch job. | |
| Get Scribe Job | ai_get_scribe_job | Get the status of a Zoom Scribe batch job. | |
| Get Scribe Job File | ai_get_scribe_job_file | Get a single output file result for a Zoom Scribe batch job. | |
| Get Summarizer Job | ai_get_summarizer_job | Get the status of a Zoom Summarizer batch job. | |
| Get Summarizer Job File | ai_get_summarizer_job_file | Get a single output file result for a Zoom Summarizer batch job. | |
| Get Translator Job | ai_get_translator_job | Get the status of a Zoom Translator batch job. | |
| Get Translator Job File | ai_get_translator_job_file | Get a single output file result for a Zoom Translator batch job. | |
| List Scribe Job Files | ai_list_scribe_job_files | List output files for a Zoom Scribe batch job. | |
| List Scribe Jobs | ai_list_scribe_jobs | List Zoom Scribe (transcription) batch jobs. | |
| List Summarizer Job Files | ai_list_summarizer_job_files | List output files for a Zoom Summarizer batch job. | |
| List Summarizer Jobs | ai_list_summarizer_jobs | List Zoom Summarizer batch jobs. | |
| List Translator Job Files | ai_list_translator_job_files | List output files for a Zoom Translator batch job. | |
| List Translator Jobs | ai_list_translator_jobs | List Zoom Translator batch jobs. | |
| Submit Scribe Job | ai_submit_scribe_job | Submit a Zoom Scribe (transcription) batch job. | |
| Submit Summarizer Job | ai_submit_summarizer_job | Submit a Zoom Summarizer batch job. | |
| Submit Translator Job | ai_submit_translator_job | Submit a Zoom Translator batch job. | |
| Summarize (Sync) | ai_summarize | Synchronously summarize text with Zoom Summarizer. | |
| Transcribe (Sync) | ai_transcribe | Synchronously transcribe audio with Zoom Scribe. | |
| Translate (Sync) | ai_translate | Synchronously translate text with Zoom Translator. |
Billing
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Addon Plan | add_addon_plan | Add an additional (addon) plan to a sub account. | |
| Create Plan Subscription | create_plan | Subscribe a sub account to a Zoom plan (base plan + optional addons). | |
| Get Billing Information | get_billing_info | Get a sub account’s billing information. | |
| Get Invoice Details | get_invoice | Get the details of a specific billing invoice for a sub account. | |
| Get Plan Information | get_plans | Get plan information for a sub account under a master account. | |
| Get Plan Usage | get_plan_usage | Get plan usage for a sub account (or master account). | |
| List Invoices | list_invoices | List a sub account’s billing invoices within a date range. | |
| Update Addon Plan | update_addon_plan | Update an additional (addon) plan for a sub account. | |
| Update Addon Plan Status | update_addon_plan_status | Update the status of a sub account’s additional (addon) plan (e.g. cancel). | |
| Update Base Plan | update_base_plan | Update a sub account’s base plan (type and/or number of hosts). | |
| Update Base Plan Status | update_base_plan_status | Update the status of a sub account’s base plan (e.g. cancel). | |
| Update Billing Information | update_billing_info | Update a sub account’s billing information (contact + address). |
Commerce
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Account Contacts | commerce_add_account_contacts | Add contacts to an existing end customer account. | |
| Create Deal Registration | commerce_create_deal_registration | Register a new deal for a Zoom partner. | |
| Create End Customer Account | commerce_create_account | Create an end customer account for a Zoom partner/reseller. | |
| Create Order | commerce_create_order | Create a subscription order for a Zoom partner. | |
| Create Quote | commerce_create_quote | Create a subscription quote for a Zoom partner. | |
| Download Billing Document | commerce_download_billing_document | Download the PDF of a billing document. | |
| Download File | commerce_download_file | Download a commerce file by document reference id. | |
| Download Pricebook | commerce_download_pricebook | Download the pricebook for a Zoom partner. | |
| Fulfill Quote | commerce_fulfill_quote | Submit a quote for provisioning/fulfillment. | |
| Get Account | commerce_get_account | Get the details of an end customer account. | |
| Get Deal Registration | commerce_get_deal_registration | Get the details of a deal registration. | |
| Get File Details | commerce_get_file_details | Get metadata for files associated with a reference id. | |
| Get Invoice | commerce_get_invoice | Get the details of an invoice by invoice number. | |
| Get Offer | commerce_get_offer | Get the details for a Zoom product or offer. | |
| Get Order | commerce_get_order | Get the details of an order by reference id. | |
| Get Product Catalog | commerce_get_catalog | Get the product catalog for a Zoom partner. | |
| Get Quote | commerce_get_quote | Get the details of a quote by reference id. | |
| Get Subscription | commerce_get_subscription | Get the details of a subscription by number. | |
| Get Subscription Versions | commerce_get_subscription_versions | Get the version history of a subscription. | |
| Get Trial | commerce_get_trial | Get the details of a trial subscription by reference id. | |
| List Accounts | commerce_list_accounts | List all partner/reseller end customer accounts. | |
| List Billing Documents | commerce_list_billing_documents | List all billing documents for a Zoom partner. | |
| List Campaigns | commerce_list_campaigns | List valid Zoom campaigns for deal registration. | |
| List Deal Registrations | commerce_list_deal_registrations | List all deal registrations for a Zoom partner. | |
| List Orders | commerce_list_orders | List all orders for a Zoom partner. | |
| List Quotes | commerce_list_quotes | List all quotes for a Zoom partner. | |
| List Subscriptions | commerce_list_subscriptions | List all paid subscriptions for a Zoom partner. | |
| List Trials | commerce_list_trials | List all trial subscriptions for a Zoom partner. | |
| Preview Order | commerce_preview_order | Preview order metrics (pricing/tax) before creating an order. | |
| Preview Quote | commerce_preview_quote | Preview quote metrics (pricing/tax) before creating a quote. | |
| Update Deal Registration | commerce_update_deal_registration | Update an existing deal registration. | |
| Update Quote | commerce_update_quote | Update an existing quote. | |
| Upload File | commerce_upload_file | Upload an attachment file associated with a commerce reference. |
Contact center
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Contact | cc_add_contact | Add a contact to a campaign contact list. | |
| Add DNC Phones | cc_add_dnc_phones | Add phone numbers to a Do Not Call (DNC) list. | |
| Add Flow Entry Points | cc_add_flow_entry_points | Add entry points to a Zoom Contact Center flow. | |
| Assign Inbox Queues | cc_assign_inbox_queues | Grant queues access to an inbox. | |
| Assign Inbox Users | cc_assign_inbox_users | Grant users access to an inbox. | |
| Assign Queue Agents | cc_assign_queue_agents | Assign agents to a Zoom Contact Center queue. | |
| Assign Queue Disposition Sets | cc_assign_queue_disposition_sets | Assign disposition sets to a Zoom Contact Center queue. | |
| Assign Queue Dispositions | cc_assign_queue_dispositions | Assign dispositions to a Zoom Contact Center queue. | |
| Assign Queue Interrupt Menu | cc_assign_queue_interrupt_menu | Assign a menu based interrupt to a Zoom Contact Center queue. | |
| Assign Queue Supervisors | cc_assign_queue_supervisors | Assign supervisors to a Zoom Contact Center queue. | |
| Assign Queue Teams | cc_assign_queue_teams | Assign teams to a Zoom Contact Center queue. | |
| Assign Region Users | cc_assign_region_users | Assign users to a Contact Center region. | |
| Assign Team Agents | cc_assign_team_agents | Assign agents (members) to a team | |
| Assign Team Supervisors | cc_assign_team_supervisors | Assign supervisors to a team | |
| Batch Create Contacts | cc_batch_create_contacts | Batch create up to 10 contacts in an address book. | |
| Batch Create Queues | cc_batch_create_queues | Batch create Zoom Contact Center queues with a template. | |
| Batch Delete Contacts | cc_batch_delete_contacts | Batch delete up to 50 contacts from an address book. | |
| Batch Delete Queues | cc_batch_delete_queues | Batch delete Zoom Contact Center queues. | |
| Batch Update Contact Lists | cc_batch_update_contact_lists | Batch update campaign contact lists. | |
| Batch Update Contacts | cc_batch_update_contacts | Batch update contacts within a campaign contact list. | |
| CC Add User Skills | cc_add_user_skills | Assign one or more skills to a Contact Center user. | |
| CC Assign Role Users | cc_assign_role_users | Assign users to a Zoom Contact Center role. | |
| CC Batch Create Users | cc_batch_create_users | Batch add multiple Zoom users to Contact Center as agents. | |
| CC Batch Delete Users | cc_batch_delete_users | Batch remove multiple users from Contact Center. | |
| CC Batch Update User Status | cc_batch_update_user_status | Batch update the engagement/agent status of multiple Contact Center users. | |
| CC Batch Update Users | cc_batch_update_users | Batch update multiple Contact Center users’ profiles. | |
| CC Create Agent Routing Profile | cc_create_agent_routing_profile | Create a Zoom Contact Center agent routing profile. | |
| CC Create Consumer Routing Profile | cc_create_consumer_routing_profile | Create a Zoom Contact Center consumer routing profile. | |
| CC Create Role | cc_create_role | Create a new Zoom Contact Center role. | |
| CC Create User | cc_create_user | Add (assign) a Zoom user to Contact Center as an agent. | |
| CC Create User Template | cc_create_user_template | Create a Contact Center user settings template. | |
| CC Delete Agent Routing Profile | cc_delete_agent_routing_profile | Delete a Zoom Contact Center agent routing profile. | |
| CC Delete Consumer Routing Profile | cc_delete_consumer_routing_profile | Delete a Zoom Contact Center consumer routing profile. | |
| CC Delete Role | cc_delete_role | Delete a Zoom Contact Center role. | |
| CC Delete Role Privileges | cc_delete_role_privileges | Remove privileges from a Zoom Contact Center role. | |
| CC Delete Role User | cc_delete_role_user | Unassign a single user from a Zoom Contact Center role. | |
| CC Delete User | cc_delete_user | Remove a user from Contact Center. | |
| CC Delete User Recordings | cc_delete_user_recordings | Delete a Contact Center user’s engagement recordings. | |
| CC Delete User Template | cc_delete_user_template | Delete a Contact Center user settings template. | |
| CC Duplicate Role | cc_duplicate_role | Duplicate an existing Zoom Contact Center role. | |
| CC Get Agent Routing Profile | cc_get_agent_routing_profile | Get a Zoom Contact Center agent routing profile. | |
| CC Get Consumer Routing Profile | cc_get_consumer_routing_profile | Get a Zoom Contact Center consumer routing profile. | |
| CC Get Role | cc_get_role | Get details of a Zoom Contact Center role. | |
| CC Get Role Users | cc_get_role_users | List users assigned to a Zoom Contact Center role. | |
| CC Get User | cc_get_user | Get a Contact Center user’s profile. | |
| CC Get User Template | cc_get_user_template | Get a Contact Center user settings template. | |
| CC List Agent Routing Profiles | cc_list_agent_routing_profiles | List Zoom Contact Center agent routing profiles. | |
| CC List Consumer Routing Profiles | cc_list_consumer_routing_profiles | List Zoom Contact Center consumer routing profiles. | |
| CC List Roles | cc_list_roles | List all Zoom Contact Center roles. | |
| CC List User Queues | cc_list_user_queues | List the queues a Contact Center user is a member of. | |
| CC List User Recordings | cc_list_user_recordings | List a Contact Center user’s engagement recordings. | |
| CC List User Skills | cc_list_user_skills | List the skills assigned to a Contact Center user. | |
| CC List User Templates | cc_list_user_templates | List Contact Center user settings templates. | |
| CC List Users | cc_list_users | List Zoom Contact Center users (agents). | |
| CC Opt In/Out Queues | cc_opt_in_out_queues | Opt a Contact Center user in or out of one or more queues. | |
| CC Remove User Skill | cc_remove_user_skill | Remove a skill from a Contact Center user. | |
| CC Update Agent Routing Profile | cc_update_agent_routing_profile | Update a Zoom Contact Center agent routing profile. | |
| CC Update Consumer Routing Profile | cc_update_consumer_routing_profile | Update a Zoom Contact Center consumer routing profile. | |
| CC Update Role | cc_update_role | Update a Zoom Contact Center role. | |
| CC Update User | cc_update_user | Update a Contact Center user’s profile. | |
| CC Update User Status | cc_update_user_status | Update a single Contact Center user’s engagement/agent status. | |
| CC Update User Template | cc_update_user_template | Update a Contact Center user settings template. | |
| Control Engagement Recording | cc_control_engagement_recording | Control a Contact Center engagement recording (pause/resume/stop/start). | |
| Control Recording | cc_control_recording | Control the recording of a live Contact Center engagement (start/pause/resume/stop). | |
| Create Address Book | cc_create_address_book | Create a new address book in Zoom Contact Center. | |
| Create Address Book Custom Field | cc_create_address_book_custom_field | Create an address book custom field. | |
| Create Address Book Unit | cc_create_address_book_unit | Create a new address book unit. | |
| Create Agent Status | cc_create_agent_status | Create a Contact Center system status. | |
| Create Business Hours | cc_create_business_hours | Create Contact Center business hours | |
| Create Campaign | cc_create_campaign | Create an outbound campaign. | |
| Create CC Asset | cc_create_asset | Create a Contact Center asset library asset. | |
| Create CC Asset Category | cc_create_asset_category | Create a Contact Center asset library category. | |
| Create CC Variable | cc_create_variable | Create a Contact Center variable. | |
| Create CC Variable Group | cc_create_variable_group | Create a Contact Center variable group. | |
| Create Closure Set | cc_create_closure | Create a Contact Center closure set | |
| Create Contact | cc_create_contact | Create a single contact in an address book. | |
| Create Contact List | cc_create_contact_list | Create a campaign contact list. | |
| Create Disposition | cc_create_disposition | Create a disposition. | |
| Create Disposition Set | cc_create_disposition_set | Create a disposition set. | |
| Create Engagement | cc_create_engagement | Create (start) a Contact Center engagement. | |
| Create Flow | cc_create_flow | Create (import) a Zoom Contact Center flow. | |
| Create Inbox | cc_create_inbox | Create a new Contact Center inbox. | |
| Create Queue | cc_create_queue | Create a Zoom Contact Center queue. | |
| Create Region | cc_create_region | Create a Contact Center region. | |
| Create Skill | cc_create_skill | Create a Zoom Contact Center skill. | |
| Create Skill Category | cc_create_skill_category | Create a Zoom Contact Center skill category. | |
| Create Team | cc_create_team | Create a Contact Center team | |
| Delete Address Book | cc_delete_address_book | Delete an address book. | |
| Delete Address Book Custom Field | cc_delete_address_book_custom_field | Delete an address book custom field. | |
| Delete Address Book Unit | cc_delete_address_book_unit | Delete an address book unit. | |
| Delete Agent Status | cc_delete_agent_status | Delete a Contact Center system status. | |
| Delete All Inbox Messages | cc_delete_inboxes_messages | Delete account-level Contact Center inbox messages. | |
| Delete Business Hours | cc_delete_business_hours | Delete Contact Center business hours | |
| Delete Campaign | cc_delete_campaign | Delete an outbound campaign. | |
| Delete CC Asset | cc_delete_asset | Delete a Contact Center asset. | |
| Delete CC Asset Category | cc_delete_asset_category | Delete a Contact Center asset library category. | |
| Delete CC Asset Items | cc_delete_asset_items | Delete specific items within a Contact Center asset. | |
| Delete CC Variable | cc_delete_variable | Delete a Contact Center variable. | |
| Delete CC Variable Group | cc_delete_variable_group | Delete a Contact Center variable group. | |
| Delete CC Variable Log | cc_delete_variable_log | Delete a Contact Center variable log entry. | |
| Delete Closure Set | cc_delete_closure | Delete a Contact Center closure set | |
| Delete Contact | cc_delete_contact | Delete a contact from a campaign contact list. | |
| Delete Contact List | cc_delete_contact_list | Delete a campaign contact list. | |
| Delete Disposition | cc_delete_disposition | Delete a disposition. | |
| Delete Disposition Set | cc_delete_disposition_set | Delete a disposition set. | |
| Delete DNC Phones | cc_delete_dnc_phones | Remove phone numbers from a Do Not Call (DNC) list. | |
| Delete Engagement Recordings | cc_delete_engagement_recordings | Delete all recordings for a Contact Center engagement. | |
| Delete Flow | cc_delete_flow | Delete a Zoom Contact Center flow. | |
| Delete Flow Entry Points | cc_delete_flow_entry_points | Delete the entry points of a Zoom Contact Center flow. | |
| Delete Inbox Message | cc_delete_inbox_message | Delete a single message within an inbox. | |
| Delete Inbox Messages | cc_delete_inbox_messages | Delete all messages within a specific inbox. | |
| Delete Inboxes | cc_delete_inboxes | Delete multiple Contact Center inboxes. | |
| Delete Queue | cc_delete_queue | Delete a Zoom Contact Center queue. | |
| Delete Queue Callback Attendee | cc_delete_queue_callback_attendee | Delete an attendee from a Zoom Contact Center queue’s scheduled callback. | |
| Delete Queue Interrupt Menu | cc_delete_queue_interrupt_menu | Delete a Zoom Contact Center queue’s interrupt menu configuration. | |
| Delete Queue Recordings | cc_delete_queue_recordings | Delete a Zoom Contact Center queue’s recordings. | |
| Delete Recording | cc_delete_recording | Delete a Contact Center recording. | |
| Delete Region | cc_delete_region | Delete a Contact Center region. | |
| Delete Skill | cc_delete_skill | Delete a Zoom Contact Center skill. | |
| Delete Skill Category | cc_delete_skill_category | Delete a Zoom Contact Center skill category. | |
| Delete Team | cc_delete_team | Delete a Contact Center team | |
| Duplicate CC Asset | cc_duplicate_asset | Duplicate a Contact Center asset. | |
| Export Flow | cc_export_flow | Export a Zoom Contact Center flow’s definition. | |
| Get Address Book | cc_get_address_book | Get the details of an address book. | |
| Get Address Book Custom Field | cc_get_address_book_custom_field | Get the details of an address book custom field. | |
| Get Address Book Unit | cc_get_address_book_unit | Get the details of an address book unit. | |
| Get Agent Status | cc_get_agent_status | Get details of a Contact Center system status. | |
| Get Business Hours | cc_get_business_hours | Get Contact Center business hours | |
| Get Campaign | cc_get_campaign | Get an outbound campaign. | |
| Get CC Asset | cc_get_asset | Get a Contact Center asset’s details and access URL. | |
| Get CC Asset Category | cc_get_asset_category | Get a Contact Center asset library category. | |
| Get CC Variable | cc_get_variable | Get a Contact Center variable’s details. | |
| Get CC Variable Group | cc_get_variable_group | Get a Contact Center variable group’s details. | |
| Get CC Variable Log | cc_get_variable_log | Get a Contact Center variable log entry. | |
| Get Closure Set | cc_get_closure | Get a Contact Center closure set | |
| Get Contact | cc_get_contact | Get a contact within a campaign contact list. | |
| Get Contact Custom Fields | cc_get_contact_custom_fields | Get the custom field values for a specific contact. | |
| Get Contact List | cc_get_contact_list | Get a campaign contact list. | |
| Get Disposition | cc_get_disposition | Get a disposition. | |
| Get Disposition Set | cc_get_disposition_set | Get a disposition set. | |
| Get Engagement | cc_get_engagement | Get details of a Contact Center engagement. | |
| Get Engagement Attachments | cc_get_engagement_attachments | List attachments of a Contact Center engagement. | |
| Get Engagement Events | cc_get_engagement_events | List the events (timeline, transfers) of a Contact Center engagement. | |
| Get Engagement Note | cc_get_engagement_note | Get a specific note on a Contact Center engagement. | |
| Get Engagement Recording Status | cc_get_engagement_recording_status | Get the recording status of a Contact Center engagement. | |
| Get Engagement Recordings | cc_get_engagement_recordings | List recordings (audio/transcript) of a Contact Center engagement. | |
| Get Engagement Survey | cc_get_engagement_survey | Get the post-engagement survey results for a Contact Center engagement. | |
| Get Flow | cc_get_flow | Get the details of a Zoom Contact Center flow. | |
| Get Historical Dataset | cc_get_historical_dataset | Get a Contact Center historical analytics dataset report. | |
| Get Historical Log | cc_get_historical_log | Get a Contact Center historical analytics log (engagement or journey). | |
| Get Inbox | cc_get_inbox | Get details of a specific Contact Center inbox. | |
| Get Inbox Email Notifications | cc_get_inbox_email_notifications | Get email notification settings for an inbox. | |
| Get Note | cc_get_note | Get a specific note for a Contact Center engagement. | |
| Get Queue | cc_get_queue | Get a Zoom Contact Center queue. | |
| Get Queue Operating Hours | cc_get_queue_operating_hours | Get a queue’s operating hours | |
| Get Region | cc_get_region | Get a Contact Center region. | |
| Get Skill | cc_get_skill | Get the details of a Zoom Contact Center skill. | |
| Get Skill Category | cc_get_skill_category | Get the details of a Zoom Contact Center skill category. | |
| Get Team | cc_get_team | Get a Contact Center team | |
| List Address Book Custom Fields | cc_list_address_book_custom_fields | List address book custom fields. | |
| List Address Book Units | cc_list_address_book_units | List all address book units in Zoom Contact Center. | |
| List Address Books | cc_list_address_books | List all address books in Zoom Contact Center. | |
| List Agent Leg Reports | cc_agent_leg_metrics | List agent leg reports (legacy reports). | |
| List Agent Status History | cc_agent_status_history | List agent’s status history reports (legacy reports). | |
| List Agent Statuses | cc_list_agent_statuses | List Contact Center user system statuses. | |
| List Agent Time Sheets | cc_agent_time_sheets | List agent’s time sheet reports (legacy reports). | |
| List All Flow Entry Points | cc_list_flows_entry_points | List entry points across all Zoom Contact Center flows. | |
| List All Inbox Messages | cc_list_inboxes_messages | List messages (voicemails/recordings) across all Contact Center inboxes. | |
| List All Notes | cc_list_all_notes | List engagement notes across the Contact Center account. | |
| List Business Hours | cc_list_business_hours | List Contact Center business hours | |
| List Business Hours Flows | cc_list_business_hours_flows | List a business hours’ flows | |
| List Business Hours Queues | cc_list_business_hours_queues | List a business hours’ queues | |
| List Campaigns | cc_list_campaigns | List outbound campaigns. | |
| List CC Asset Categories | cc_list_asset_categories | List Contact Center asset library categories. | |
| List CC Assets | cc_list_assets | List Contact Center asset library assets (media, prompts, files). | |
| List CC Variable Groups | cc_list_variable_groups | List Contact Center variable groups. | |
| List CC Variable Logs | cc_list_variable_logs | List Contact Center variable change logs. | |
| List CC Variables | cc_list_variables | List Contact Center variables. | |
| List Closure Flows | cc_list_closure_flows | List a closure set’s flows | |
| List Closure Queues | cc_list_closure_queues | List a closure set’s queues | |
| List Closures | cc_list_closures | List Contact Center closure sets | |
| List Contact Lists | cc_list_contact_lists | List campaign contact lists. | |
| List Contacts | cc_list_contacts | List contacts within a campaign contact list. | |
| List Disposition Sets | cc_list_disposition_sets | List disposition sets. | |
| List Dispositions | cc_list_dispositions | List dispositions. | |
| List DNC Phones | cc_list_dnc_phones | List phone numbers in a Do Not Call (DNC) list. | |
| List Email Logs | cc_list_email_logs | List Contact Center email engagement logs. | |
| List Engagement Notes | cc_list_engagement_notes | List notes for a specific Contact Center engagement. | |
| List Engagement Recordings | cc_list_engagement_recordings | List recordings for a specific Contact Center engagement. | |
| List Engagements | cc_list_engagements | List Contact Center engagement logs. | |
| List Flow Entry Points | cc_list_flow_entry_points | List the entry points of a Zoom Contact Center flow. | |
| List Flows | cc_list_flows | List all Zoom Contact Center flows. | |
| List Historical Agent Performance | cc_hist_agent_performance | List historical agent performance dataset data (CX Analytics). | |
| List Historical Agent Reports by Queue | cc_queue_agents_metrics | List historical agent reports by queue (legacy reports). | |
| List Historical Agent Timecard | cc_hist_agent_timecard | List historical agent timecard dataset data (CX Analytics). | |
| List Historical Call Journey Data | cc_hist_journey_log | List historical Zoom Phone to Contact Center call journey log data (CX Analytics). | |
| List Historical Detail Reports | cc_historical_detail_metrics | List historical detail reports (legacy reports). | |
| List Historical Disposition Data | cc_hist_disposition | List historical disposition dataset data (CX Analytics). | |
| List Historical Engagement Data | cc_hist_engagement | List historical engagement dataset data (CX Analytics). | |
| List Historical Engagement Logs | cc_hist_engagement_log | List historical engagement log data (CX Analytics). | |
| List Historical Expert Assist Data | cc_hist_expert_assist | List historical expert assist dataset data (CX Analytics). | |
| List Historical Flow Performance | cc_hist_flow_performance | List historical flow performance dataset data (CX Analytics). | |
| List Historical Outbound Dialer Performance | cc_hist_outbound_dialer_performance | List historical outbound dialer performance dataset data (CX Analytics). | |
| List Historical Queue Performance | cc_hist_queue_performance | List historical queue performance dataset data (CX Analytics). | |
| List Historical Queue Reports | cc_historical_queue_metrics | List historical queue reports (legacy reports). | |
| List Historical Queue’s Agents Reports | cc_queue_agent_metrics | List a historical queue’s agents reports (legacy reports). | |
| List Inbox Messages | cc_list_inbox_messages | List messages (voicemails/recordings) within a specific inbox. | |
| List Inbox Queues | cc_list_inbox_queues | List queues that have access to an inbox. | |
| List Inbox Users | cc_list_inbox_users | List users that have access to an inbox. | |
| List Inboxes | cc_list_inboxes | List all Contact Center inboxes on the account. | |
| List Messaging Logs | cc_list_messaging_logs | List Contact Center messaging engagement logs. | |
| List Notes | cc_list_notes | List all Contact Center engagement notes across engagements. | |
| List Operation Logs | cc_list_operation_logs | List Contact Center operation (audit) logs. | |
| List Queue Agents | cc_list_queue_agents | List agents assigned to a Zoom Contact Center queue. | |
| List Queue Callback Slots | cc_list_queue_callback_slots | List a Zoom Contact Center queue’s scheduled callback availability slots. | |
| List Queue Disposition Sets | cc_list_queue_disposition_sets | List disposition sets assigned to a Zoom Contact Center queue. | |
| List Queue Dispositions | cc_list_queue_dispositions | List dispositions assigned to a Zoom Contact Center queue. | |
| List Queue Recordings | cc_list_queue_recordings | List a Zoom Contact Center queue’s recordings. | |
| List Queue Supervisors | cc_list_queue_supervisors | List supervisors assigned to a Zoom Contact Center queue. | |
| List Queues | cc_list_queues | List Zoom Contact Center queues. | |
| List Recordings | cc_list_recordings | List Contact Center recordings. | |
| List Region Users | cc_list_region_users | List users assigned to a Contact Center region. | |
| List Regions | cc_list_regions | List Contact Center regions. | |
| List Skill Categories | cc_list_skill_categories | List all Zoom Contact Center skill categories. | |
| List Skill Users | cc_list_skill_users | List the users assigned to a Zoom Contact Center skill. | |
| List Skills | cc_list_skills | List all Zoom Contact Center skills. | |
| List SMS Logs | cc_list_sms_logs | List Contact Center SMS engagement logs. | |
| List Team Agents | cc_list_team_agents | List a team’s agents (members) | |
| List Team Children | cc_list_team_children | List a team’s child teams | |
| List Team Parents | cc_list_team_parents | List a team’s parent teams | |
| List Team Supervisors | cc_list_team_supervisors | List a team’s supervisors | |
| List Teams | cc_list_teams | List Contact Center teams | |
| List User Devices | cc_list_user_devices | List the devices of a Contact Center user. | |
| List Voice Call Logs | cc_list_voice_call_logs | List Contact Center voice call engagement logs. | |
| List Work Item Logs | cc_list_work_item_logs | List Contact Center work item engagement logs. | |
| Move Team | cc_move_team | Move a team under a new parent team | |
| Publish Flow | cc_publish_flow | Publish a Zoom Contact Center flow. | |
| Schedule Queue Callback | cc_schedule_queue_callback | Schedule a callback on a Zoom Contact Center queue. | |
| Send Message | cc_send_message | Send a Contact Center message (messaging channel). | |
| Send SMS | cc_send_sms | Send an SMS from a Contact Center SMS-capable number to consumer numbers. | |
| Send User Command | cc_send_user_command | Send a call control command to a Contact Center user’s device. | |
| Set Campaign Status | cc_set_campaign_status | Change a campaign’s status (start, stop, pause, resume). | |
| Unassign Inbox Queues | cc_unassign_inbox_queues | Revoke queue access from an inbox. | |
| Unassign Inbox Users | cc_unassign_inbox_users | Revoke user access from an inbox. | |
| Unassign Queue Agent | cc_unassign_queue_agent | Unassign an agent from a Zoom Contact Center queue. | |
| Unassign Queue Disposition | cc_unassign_queue_disposition | Unassign a disposition from a Zoom Contact Center queue. | |
| Unassign Queue Disposition Set | cc_unassign_queue_disposition_set | Unassign a disposition set from a Zoom Contact Center queue. | |
| Unassign Queue Supervisor | cc_unassign_queue_supervisor | Unassign a supervisor from a Zoom Contact Center queue. | |
| Unassign Queue Team | cc_unassign_queue_team | Unassign a team from a Zoom Contact Center queue. | |
| Unassign Queue Teams | cc_unassign_queue_teams | Unassign multiple teams from a Zoom Contact Center queue. | |
| Unassign Team Agents | cc_unassign_team_agents | Unassign agents (members) from a team | |
| Unassign Team Supervisors | cc_unassign_team_supervisors | Unassign supervisors from a team | |
| Update Address Book | cc_update_address_book | Update an existing address book. | |
| Update Address Book Custom Field | cc_update_address_book_custom_field | Update an address book custom field. | |
| Update Address Book Unit | cc_update_address_book_unit | Update an existing address book unit. | |
| Update Agent Status | cc_update_agent_status | Update a Contact Center system status. | |
| Update Business Hours | cc_update_business_hours | Update Contact Center business hours | |
| Update Campaign | cc_update_campaign | Update an outbound campaign. | |
| Update CC Asset | cc_update_asset | Update a Contact Center asset’s metadata or content. | |
| Update CC Asset Category | cc_update_asset_category | Update a Contact Center asset library category. | |
| Update CC Variable | cc_update_variable | Update a Contact Center variable. | |
| Update CC Variable Group | cc_update_variable_group | Update a Contact Center variable group. | |
| Update Closure Set | cc_update_closure | Update a Contact Center closure set | |
| Update Contact | cc_update_contact | Update a contact within a campaign contact list. | |
| Update Contact List | cc_update_contact_list | Update a campaign contact list. | |
| Update Disposition | cc_update_disposition | Update a disposition. | |
| Update Disposition Set | cc_update_disposition_set | Update a disposition set. | |
| Update Engagement | cc_update_engagement | Update a Contact Center engagement (e.g. transfer to agent/queue, set fields). | |
| Update Engagement Note | cc_update_engagement_note | Update a note on a Contact Center engagement. | |
| Update Flow | cc_update_flow | Edit a Zoom Contact Center flow. | |
| Update Inbox | cc_update_inbox | Update a Contact Center inbox. | |
| Update Inbox Email Notification | cc_update_inbox_email_notification | Update email notification settings for an inbox. | |
| Update Note | cc_update_note | Update a Contact Center engagement note. | |
| Update Queue | cc_update_queue | Update a Zoom Contact Center queue. | |
| Update Queue Agent | cc_update_queue_agent | Update an agent assigned to a Zoom Contact Center queue. | |
| Update Queue Interrupt | cc_update_queue_interrupt | Update a Zoom Contact Center queue’s interrupt settings. | |
| Update Queue Operating Hours | cc_update_queue_operating_hours | Update a queue’s operating hours | |
| Update Region | cc_update_region | Update a Contact Center region. | |
| Update Skill | cc_update_skill | Update a Zoom Contact Center skill. | |
| Update Skill Category | cc_update_skill_category | Update a Zoom Contact Center skill category. | |
| Update Team | cc_update_team | Update a Contact Center team |
Contacts
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Contact Group Members | add_contact_group_members | Add members to a contact group. | |
| Create Contact Group | create_contact_group | Create a contact group under an account. | |
| Delete Contact Group | delete_contact_group | Delete a contact group under an account. | |
| Get Company Contact | get_company_contact | Get details of a specific company (directory) contact. | |
| Get Contact Group | get_contact_group | Get a specific contact group under an account. | |
| Get User Contact | get_user_contact | Get details of one of the current user’s Zoom Chat contacts. | |
| List Contact Group Members | list_contact_group_members | List the members of a contact group. | |
| List Contact Groups | list_contact_groups | List all contact groups under an account. | |
| List User Contacts | list_user_contacts | List the current user’s Zoom Chat contacts. | |
| Remove Contact Group Member | remove_contact_group_member | Remove a member from a contact group. | |
| Search Company Contacts | search_company_contacts | Search an account’s company (directory) contacts. | |
| Update Contact Group | update_contact_group | Update a contact group under an account. |
Dashboards
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Dashboard: Chat Metrics | dashboard_chat_metrics | Get Zoom Chat usage metrics for a monthly date range (last 6 months). | |
| Dashboard: Client Feedback Detail | dashboard_client_feedback_detail | Get participant-level detail for a client satisfaction feedback type. | |
| Dashboard: Client Satisfaction | dashboard_client_satisfaction | Get Zoom meetings client satisfaction metrics for a date range. | |
| Dashboard: CRC Port Usage | dashboard_crc_port_usage | Get the hour-by-hour CRC (Conference Room Connector) port usage. | |
| Dashboard: Get Client Feedback | dashboard_get_client_feedback | Get detail of a specific Zoom meetings client feedback by feedback ID. | |
| Dashboard: Get Meeting Details | get_dashboard_meeting | Get metric details for a single meeting. | |
| Dashboard: Get Meeting Participant QoS | get_dashboard_meeting_participant_qos | Get quality of service (QoS) data for a single meeting participant. | |
| Dashboard: Get Webinar Details | get_dashboard_webinar | Get metric details for a single webinar. | |
| Dashboard: Get Webinar Participant QoS | get_dashboard_webinar_participant_qos | Get quality of service (QoS) data for a single webinar participant. | |
| Dashboard: Get Zoom Room Details | dashboard_get_zoom_room | Get detailed metrics for a specific Zoom Room over a date range. | |
| Dashboard: IM Metrics | dashboard_im_metrics | Get IM (instant messaging) metrics for users over a date range. | |
| Dashboard: List Client Feedback | dashboard_list_client_feedback | List Zoom meetings client feedback (thumbs up/down) for a date range. | |
| Dashboard: List Meeting Participant Sharing | list_dashboard_meeting_participants_sharing | List sharing and recording details for participants in a meeting. | |
| Dashboard: List Meeting Participants | list_dashboard_meeting_participants | List participants from a past or live meeting with metric details. | |
| Dashboard: List Meeting Participants QoS | list_dashboard_meeting_participants_qos | List quality of service (QoS) data for all participants in a meeting. | |
| Dashboard: List Meeting Satisfaction | list_dashboard_meeting_participants_satisfaction | List the meeting satisfaction (thumbs up/down) ratings from participants. | |
| Dashboard: List Meetings | list_dashboard_meetings | List meetings on the account with QoS-relevant metrics for a date range. | |
| Dashboard: List Webinar Participant Sharing | list_dashboard_webinar_participants_sharing | List sharing and recording details for participants in a webinar. | |
| Dashboard: List Webinar Participants | list_dashboard_webinar_participants | List participants from a past or live webinar with metric details. | |
| Dashboard: List Webinar Participants QoS | list_dashboard_webinar_participants_qos | List quality of service (QoS) data for all participants in a webinar. | |
| Dashboard: List Webinar Satisfaction | list_dashboard_webinar_participants_satisfaction | List the webinar satisfaction (thumbs up/down) ratings from participants. | |
| Dashboard: List Webinars | list_dashboard_webinars | List webinars on the account with QoS-relevant metrics for a date range. | |
| Dashboard: List Zoom Rooms | dashboard_list_zoom_rooms | List Zoom Rooms with metrics for the specified date range. | |
| Dashboard: Top 25 Zoom Room Issue Types | dashboard_top_issue_types_zoom_rooms | Get the top 25 issue types across all Zoom Rooms for a month. | |
| Dashboard: Top 25 Zoom Rooms With Issues | dashboard_top_issue_zoom_rooms | Get the top 25 Zoom Rooms with issues for a month. | |
| Dashboard: Zoom Room Issues | dashboard_zoom_room_issues | Get the issues of a specific Zoom Room for a month. |
Devices
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add SIP Call-out Countries | add_sip_callout_countries | Add internal SIP call-out countries (SIP Connected Audio). | |
| Add SIP Internal Numbers | add_sip_internal_numbers | Add internal SIP Connected Audio numbers. | |
| Assign SIP Trunk Numbers | assign_sip_trunk_numbers | Assign phone numbers to the account’s SIP trunk configuration. | |
| Create H.323/SIP Device | create_h323_device | Register a new H.323/SIP device with the Zoom Room Connector. | |
| Create SIP Phone | create_sip_phone | Add a SIP phone using a user’s assigned credentials (SIP integration). | |
| Delete All SIP Trunk Numbers | delete_all_sip_trunk_numbers | Delete all phone numbers assigned to the account’s SIP trunk. | |
| Delete H.323/SIP Device | delete_h323_device | Delete an H.323/SIP device from the account. | |
| Delete SIP Call-out Country | delete_sip_callout_country | Delete a single internal SIP call-out country. | |
| Delete SIP Internal Number | delete_sip_internal_number | Delete a single internal SIP Connected Audio number. | |
| Delete SIP Phone | delete_sip_phone | Delete a SIP phone from the account. | |
| Get Account TSP | get_tsp | Get the account’s Telephony Service Provider (TSP) information. | |
| List H.323/SIP Devices | list_h323_devices | List all H.323/SIP devices on the account (Room Connector devices). | |
| List SIP Call-out Countries | list_sip_callout_countries | List the internal (customer-provided) SIP call-out countries. | |
| List SIP Internal Numbers | list_sip_internal_numbers | List internal (customer-provided) SIP Connected Audio numbers. | |
| List SIP Phones | list_sip_phones | List the SIP phones on the account. | |
| List SIP Trunk Numbers | list_sip_trunk_numbers | List the phone numbers assigned to the account’s SIP trunk. | |
| Update Account TSP | update_tsp | Update the account’s TSP (3rd-party audio conferencing) settings. | |
| Update H.323/SIP Device | update_h323_device | Update an existing H.323/SIP device. | |
| Update SIP Phone | update_sip_phone | Update a SIP phone’s configuration. | |
| Update SIP Trunk Settings | update_sip_trunk_settings | Update the account’s SIP Connected Audio (SIP trunk) settings. |
Docs
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Collaborators | docs_add_collaborators | Add collaborators to a Zoom Docs file. | |
| Create Doc | docs_create_doc | Create a new Zoom Docs file. | |
| Create Export | docs_create_export | Create a Zoom Docs file export job. | |
| Create Import | docs_create_import | Create a new Zoom Docs file by import. | |
| Delete File | docs_delete_file | Delete a Zoom Docs file. | |
| Get Export Status | docs_get_export_status | Get the status of a Zoom Docs file export job. | |
| Get File Metadata | docs_get_file | Query metadata for a Zoom Docs file. | |
| Get General Access | docs_get_general_access | Get the general access setting of a Zoom Docs file. | |
| Get Import Status | docs_get_import_status | Get the status of a Zoom Docs file import job. | |
| List Children | docs_list_children | List all child files/folders of a Zoom Docs file or folder. | |
| List Collaborators | docs_list_collaborators | List collaborators of a Zoom Docs file. | |
| Remove Collaborator | docs_remove_collaborator | Remove a collaborator from a Zoom Docs file. | |
| Update Collaborator Role | docs_update_collaborator | Modify a collaborator’s role on a Zoom Docs file. | |
| Update File Metadata | docs_update_file | Modify metadata of a Zoom Docs file. | |
| Update General Access | docs_update_general_access | Modify the general access setting of a Zoom Docs file. | |
| Upload File | docs_upload_file | Upload a file for Zoom Docs import or attachments. |
Groups
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Group Admins | add_group_admins | Add administrators to a group. | |
| Add Group Members | add_group_members | Add members to a group under an account. | |
| Create Group | create_group | Create a group under an account. | |
| Delete Group | delete_group | Delete a group under an account. | |
| Delete Group Admin | delete_group_admin | Remove an administrator from a group. | |
| Delete Group Member | delete_group_member | Remove a member from a group under an account. | |
| Delete Group Virtual Background | delete_group_virtual_background | Delete virtual background files from a group. | |
| Get Group | get_group | Get a group under an account. | |
| Get Group Lock Settings | get_group_lock_settings | Get a group’s locked settings. | |
| Get Group Settings | get_group_settings | Get a group’s settings. | |
| List Group Admins | list_group_admins | List the administrators of a group. | |
| List Group Members | list_group_members | List the members of a group under an account. | |
| List Groups | list_groups | List all groups under an account. | |
| Update Group | update_group | Update a group under an account. | |
| Update Group Lock Settings | update_group_lock_settings | Update a group’s locked settings. Locked settings cannot be changed by group members. | |
| Update Group Settings | update_group_settings | Update a group’s settings. | |
| Upload Group Virtual Background | upload_group_virtual_background | Upload virtual background files for a group’s use. |
IM groups
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add IM Group Members | add_im_group_members | Add members to an IM directory group. | |
| Create IM Group | create_im_group | Create an IM directory group under an account. | |
| Delete IM Group | delete_im_group | Delete an IM directory group under an account. | |
| Delete IM Group Member | delete_im_group_member | Delete a member from an IM directory group. | |
| Get IM Group | get_im_group | Retrieve an IM directory group under an account. | |
| List IM Group Members | list_im_group_members | List the members of an IM directory group. | |
| List IM Groups | list_im_groups | List IM directory groups under an account. | |
| Update IM Group | update_im_group | Update an IM directory group under an account. |
Marketplace
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add App Requests | marketplace_add_app_requests | Add allow requests for users on a Marketplace app. | |
| Create App | marketplace_create_app | Create a new Marketplace app. | |
| Create App Deeplink | marketplace_create_app_deeplink | Generate a deeplink for a Marketplace app. | |
| Create Event Subscription | marketplace_create_event_subscription | Create a Marketplace app event subscription. | |
| Create Zoom App Deeplink | marketplace_create_zoomapp_deeplink | Generate a Zoom App deeplink. | |
| Data Compliance (Deauthorize) | marketplace_deauthorize | Notify Zoom of data compliance after an app deauthorization event. | |
| Delete App | marketplace_delete_app | Delete a Marketplace app. | |
| Delete Event Subscription | marketplace_delete_event_subscription | Delete a specific Marketplace app event subscription. | |
| Export Manifest | marketplace_export_manifest | Export a Marketplace app’s manifest. | |
| Generate App Deeplink | marketplace_generate_deeplink | Generate a deeplink for a Marketplace app. | |
| Get API Call Logs | marketplace_get_api_call_logs | Get API call logs for a Marketplace app. | |
| Get App | marketplace_get_app | Get information about a Marketplace app. | |
| Get App Requests | marketplace_get_app_requests | Get the list of user requests for a Marketplace app. | |
| Get Monetization Entitlements | marketplace_get_monetization_entitlements | Get app user entitlements for monetized Marketplace apps. | |
| Get User Apps | marketplace_get_user_apps | Get the list of apps a user has requested or subscribed to. | |
| Get User Entitlements | marketplace_get_user_entitlements | Get a user’s Marketplace app entitlements. | |
| Get Webhook Logs | marketplace_get_webhook_logs | Get webhook logs for a Marketplace app. | |
| List API Call Logs | marketplace_list_api_call_logs | List a Marketplace app’s API call logs. | |
| List Apps | marketplace_list_apps | List Marketplace apps for the account. | |
| List Event Subscriptions | marketplace_list_event_subscriptions | List Marketplace app event subscriptions. | |
| List Webhook Logs | marketplace_list_webhook_logs | List a Marketplace app’s webhook delivery logs. | |
| Rotate Client Secret | marketplace_rotate_client_secret | Rotate a Marketplace app’s client secret. | |
| Subscribe To Event Subscription | marketplace_subscribe_event_subscription | Subscribe an account/team/users to an existing event subscription. | |
| Unsubscribe Event Subscription | marketplace_unsubscribe_event_subscription | Unsubscribe from all Marketplace app event subscriptions. | |
| Update App Manifest | marketplace_update_app_manifest | Update a Marketplace app using its manifest. | |
| Update App Requests | marketplace_update_app_requests | Update the status of user requests for a Marketplace app. | |
| Update Event Subscription | marketplace_update_event_subscription | Update a Marketplace app event subscription. | |
| Update Pre-Approval | marketplace_pre_approve_app | Update the pre-approval setting for a Marketplace app. | |
| Update User App Subscription | marketplace_update_user_app_subscription | Enable or disable a user’s subscription to a Marketplace app. | |
| Validate Manifest | marketplace_validate_manifest | Validate a Marketplace app manifest. |
Meetings
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Meeting Registrant | add_meeting_registrant | Register a user for a meeting that requires registration. | |
| Batch Add Meeting Registrants | batch_add_meeting_registrants | Register up to 30 registrants at once for a meeting. | |
| Batch Create Meeting Polls | batch_create_meeting_polls | Create a batch of polls for a meeting. | |
| Create Meeting | create_meeting | Schedule a new meeting for a user. | |
| Create Meeting Invite Links | create_meeting_invite_links | Create one or more join links (personalized invite links) for a meeting. | |
| Create Meeting Poll | create_meeting_poll | Create a poll for a meeting. | |
| Create Meeting Template | create_meeting_template | Create a meeting template from an existing meeting. | |
| Delete Live Meeting Chat Message | delete_live_meeting_chat_message | Delete an in-meeting chat message from a live meeting. | |
| Delete Meeting | delete_meeting | Delete a meeting. | |
| Delete Meeting Poll | delete_meeting_poll | Delete a specific meeting poll. | |
| Delete Meeting Registrant | delete_meeting_registrant | Delete a specific meeting registrant. | |
| Delete Meeting Summary | delete_meeting_summary | Delete the AI Companion summary for a specific meeting. | |
| Delete Meeting Survey | delete_meeting_survey | Delete a meeting’s post-meeting survey. | |
| Get Live Streaming Join Token | get_meeting_live_streaming_join_token | Get a join token for live streaming a meeting. | |
| Get Local Archiving Join Token | get_meeting_local_archiving_join_token | Get a join token (archive token) for local archiving of a meeting. | |
| Get Local Recording Join Token | get_meeting_local_recording_join_token | Get a join token for local recording of a meeting. | |
| Get Meeting | get_meeting | Retrieve details of a specific meeting. | |
| Get Meeting Invitation | get_meeting_invitation | Retrieve the meeting invitation text. | |
| Get Meeting Livestream | get_meeting_livestream | Retrieve a meeting’s live stream configuration. | |
| Get Meeting Poll | get_meeting_poll | Get details of a specific meeting poll. | |
| Get Meeting Registrant | get_meeting_registrant | Get details of a specific meeting registrant. | |
| Get Meeting Registration Questions | get_meeting_registration_questions | Get the registration questions configured for a meeting. | |
| Get Meeting SIP Dialing | meeting_sip_dialing | Get SIP URI details (dial-in) with a passcode for a meeting. | |
| Get Meeting Summary | get_meeting_summary | Get the AI Companion summary for a specific meeting. | |
| Get Meeting Survey | get_meeting_survey | Retrieve a meeting’s post-meeting survey. | |
| Get Meeting Token | get_meeting_token | Get a meeting’s local recording/live-streaming/closed-caption token. | |
| Get Past Meeting | get_past_meeting | Retrieve details of a completed meeting instance. | |
| List Meeting Polls | list_meeting_polls | List all polls of a meeting. | |
| List Meeting Registrants | list_meeting_registrants | List registrants of a meeting. | |
| List Meeting Summaries | list_meeting_summaries | List AI Companion meeting summaries for the account. | |
| List Meeting Templates | list_meeting_templates | List a user’s meeting templates. | |
| List Meetings | list_meetings | List scheduled meetings for a user. | |
| List Past Meeting Instances | list_past_meeting_instances | List all instances of a past meeting. | |
| List Past Meeting Polls | list_past_meeting_polls | List poll results of a past meeting. | |
| List Past Meeting Q&A | list_past_meeting_qa | List Q&A results of a past meeting. | |
| List Past Participants | list_past_participants | List participants who attended a past meeting. | |
| List Upcoming Meetings | list_upcoming_meetings | List a user’s upcoming meetings (scheduled within the next 24 hours). | |
| Update Live Meeting Chat Message | update_live_meeting_chat_message | Edit an in-meeting chat message in a live meeting. | |
| Update Live Meeting RTMS Status | update_live_meeting_rtms_status | Start or stop the RTMS app for a live meeting. | |
| Update Meeting | update_meeting | Update a scheduled meeting’s settings. | |
| Update Meeting Livestream | update_meeting_livestream | Update a meeting’s live stream configuration. | |
| Update Meeting Livestream Status | update_meeting_livestream_status | Start or stop a meeting’s live stream. | |
| Update Meeting Poll | update_meeting_poll | Update a specific meeting poll. | |
| Update Meeting Registrant Status | update_meeting_registrant_status | Approve, deny, or cancel meeting registrants. | |
| Update Meeting Registration Questions | update_meeting_registration_questions | Update the registration questions for a meeting. | |
| Update Meeting Status | update_meeting_status | End a live meeting or mark a meeting as ended/recovered. | |
| Update Meeting Survey | update_meeting_survey | Update a meeting’s post-meeting survey. | |
| Use In-Meeting Controls | use_in_meeting_controls | Use in-meeting controls (recording, RTMS) on a live meeting. |
Number management
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add BYOC Numbers | num_add_byoc_numbers | Add BYOC (Bring Your Own Carrier) phone numbers to the account (Number Management). | |
| Add Peering Numbers | num_add_peering_numbers | Add Cloud Peering (Provider Exchange) phone numbers (Number Management). | |
| Allocate/Unallocate Numbers | num_allocate_numbers | Allocate or unallocate phone numbers to a Zoom product (Number Management). | |
| Assign Calling Plan to User | num_assign_calling_plan | Assign a calling plan to a user (number provisioning; classic Phone endpoint). | |
| Assign Numbers to Campaign | num_assign_campaign_numbers | Assign phone numbers to an SMS/10DLC campaign (Number Management). | |
| Assign Numbers to User | num_assign_numbers_to_user | Assign phone numbers to a user (number provisioning; classic Phone endpoint). | |
| Create SMS Consent | num_create_sms_consent | Create an SMS consent policy (Number Management). | |
| Delete SMS Consent | num_delete_sms_consent | Delete SMS consent policies (Number Management). | |
| Delete Unassigned Numbers | num_delete_numbers | Delete one or more unassigned phone numbers from the account (Number Management). | |
| Get Phone (Account) Number | num_get_phone_number | Get a Zoom Phone account phone number’s details (classic Phone endpoint). | |
| Get Phone Number | num_get_number | Get detailed information about a specific phone number (Number Management). | |
| Get SMS Campaign | num_get_sms_campaign | Get details of a specific SMS/10DLC campaign (Number Management). | |
| Get SMS Consent | num_get_sms_consent | Get a specific SMS consent policy (Number Management). | |
| List Carrier Peering Numbers | num_list_carrier_peering_numbers | List carrier peering phone numbers for a Provider Exchange carrier (Number Management). | |
| List Number Plan Info | num_list_plan | List phone number plan (subscription/usage/availability) information (Number Management). | |
| List Peering Numbers | num_list_peering_numbers | List Cloud Peering (Provider Exchange) phone numbers (Number Management). | |
| List Phone (Account) Numbers | num_list_phone_numbers | List Zoom Phone account phone numbers (classic Phone endpoint). | |
| List Phone Numbers | num_list_numbers | List all phone numbers in a Zoom Phone / Contact Center account (Number Management). | |
| List SMS Campaigns | num_list_sms_campaigns | List SMS/10DLC campaigns (Number Management). | |
| List SMS Consent | num_list_sms_consent | List SMS consent policies (Number Management). | |
| Remove Peering Numbers | num_remove_peering_numbers | Remove Cloud Peering (Provider Exchange) phone numbers (Number Management). | |
| Unassign Calling Plan from User | num_unassign_calling_plan | Unassign a calling plan from a user (classic Phone endpoint). | |
| Unassign Number from User | num_unassign_number_from_user | Unassign a phone number from a user (classic Phone endpoint). | |
| Unassign Numbers from Campaign | num_unassign_campaign_numbers | Unassign phone numbers from an SMS/10DLC campaign (Number Management). | |
| Update Number Site | num_update_phone_number_site | Update a Zoom Phone number’s assigned site (classic Phone endpoint). | |
| Update Peering Numbers | num_update_peering_numbers | Update Cloud Peering (Provider Exchange) phone numbers (Number Management). | |
| Update Phone Number | num_update_number | Update a phone number’s capabilities, caller ID name, display name, or SIP group (Number Management). | |
| Update SMS Consent | num_update_sms_consent | Update an SMS consent policy (Number Management). |
Phone
| Operation | ID | Description | Trigger |
|---|---|---|---|
| List Call Logs | list_call_logs | List account call logs (Zoom Phone license required). |
Quality management
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Interaction | qm_add_interaction | Add a quality management interaction from a recording download URL. | |
| Create Knowledge Base Article | va_create_article | Create a Virtual Agent knowledge base article. | |
| Create SCIM Group | scim_create_group | Create a SCIM2 group. | |
| Create SCIM User | scim_create_user | Create a SCIM2 user. | |
| Delete Chatbot Message | chatbot_delete_message | Delete a chatbot message. | |
| Delete Knowledge Base Article | va_delete_article | Delete a Virtual Agent knowledge base article. | |
| Delete SCIM Group | scim_delete_group | Delete a SCIM2 group. | |
| Delete SCIM User | scim_delete_user | Delete a SCIM2 user. | |
| Edit Chatbot Message | chatbot_edit_message | Edit a chatbot message. | |
| Get Engagement Query Details Report | va_report_engagement_details | Get Virtual Agent engagement query details report. | |
| Get Engagement Variables Report | va_report_engagement_variables | Get Virtual Agent engagement variables report. | |
| Get Engagements Report | va_report_engagements | Get Virtual Agent engagement report. | |
| Get Evaluation Details | qm_get_evaluation | View details of a specific quality management evaluation. | |
| Get Interaction Details | qm_get_interaction | View details of a specific quality management interaction. | |
| Get Knowledge Base Article | va_get_article | Get a Virtual Agent knowledge base article. | |
| Get SCIM Group | scim_get_group | Get a SCIM2 group. | |
| Get SCIM User | scim_get_user | Get a SCIM2 user. | |
| Get Surveys Report | va_report_surveys | Get Virtual Agent surveys report. | |
| Get Sync Status | va_get_sync_status | Get the status of a Virtual Agent knowledge base sync. | |
| Get Transcripts Report | va_report_transcripts | Get Virtual Agent transcripts report. | |
| List Automated Evaluations | qm_list_automated_evaluations | List automated (AI) quality management evaluations. | |
| List Interactions | qm_list_interactions | List quality management interactions. | |
| List Knowledge Base Articles | va_list_articles | List Virtual Agent knowledge base articles. | |
| List Manual Evaluations | qm_list_manual_evaluations | List manual quality management evaluations. | |
| List SCIM Groups | scim_list_groups | List SCIM2 groups. | |
| List SCIM Users | scim_list_users | List SCIM2 users. | |
| Patch SCIM Group | scim_patch_group | Patch a SCIM2 group (add/remove/replace members). | |
| Patch SCIM User | scim_patch_user | Patch (partially update) a SCIM2 user. | |
| Send Chatbot Message | chatbot_send_message | Send a chatbot message to Zoom Team Chat. | |
| Sync Knowledge Base | va_sync_kb | Trigger a sync for a Virtual Agent knowledge base. | |
| Update Knowledge Base Article | va_update_article | Update a Virtual Agent knowledge base article. | |
| Update SCIM Group | scim_update_group | Replace a SCIM2 group (PUT). | |
| Update SCIM User | scim_update_user | Replace a SCIM2 user (PUT). |
Recordings
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Recording Registrant | create_recording_registrant | Register a viewer for a meeting’s on-demand cloud recording. | |
| Delete Meeting Recordings | delete_meeting_recordings | Delete a meeting’s cloud recordings. | |
| Delete Past Meeting Archive Files | delete_past_meeting_archive_files | Delete the archived files for a specific past meeting/webinar instance. | |
| Delete Recording File | delete_recording_file | Delete a single cloud recording file for a meeting. | |
| Get Archive File Statistics | get_archive_file_statistics | Get statistics on archived files across the account for a date range. | |
| Get Meeting Recordings | get_meeting_recordings | Get cloud recording files for a meeting. | |
| Get Past Meeting Archive Files | get_past_meeting_archive_files | Get the archived files for a specific past meeting/webinar instance. | |
| Get Recording Analytics Details | get_recording_analytics_details | Get detailed analytics for a meeting’s cloud recording (per-viewer detail). | |
| Get Recording Analytics Summary | get_recording_analytics_summary | Get an analytics summary for a meeting’s cloud recording. | |
| Get Recording Registrant Questions | get_recording_registrant_questions | Get the registration questions for a meeting’s on-demand cloud recording. | |
| Get Recording Settings | get_recording_settings | Get the cloud recording settings for a meeting. | |
| List Account Recordings | list_account_recordings | List all cloud recordings across the account. | |
| List Archive Files | list_archive_files | List archived meeting/webinar files across the account (date-filterable). | |
| List Recording Registrants | list_recording_registrants | List registrants for a meeting’s on-demand cloud recording. | |
| List User Recordings | list_user_recordings | List a user’s cloud recordings (date-filterable). | |
| Recover Meeting Recordings | recover_meeting_recordings | Recover all deleted cloud recordings for a meeting (from trash). | |
| Recover Recording File | recover_recording_file | Recover a single deleted cloud recording file (from trash). | |
| Update Archive File | update_archive_file | Update the auto-delete status of a single archived file. | |
| Update Recording Registrant Questions | update_recording_registrant_questions | Update the registration questions for a meeting’s on-demand cloud recording. | |
| Update Recording Registrant Status | update_recording_registrant_status | Approve or deny registrants for a meeting’s on-demand cloud recording. | |
| Update Recording Settings | update_recording_settings | Update the cloud recording settings (access, password, approval) for a meeting. |
Reports
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Get Active/Inactive Host Report | get_report_users | Retrieve active/inactive host reports for a date range (max 1 month span). | |
| Get Billing Invoice Report | get_report_billing_invoices | Retrieve invoice reports for a billing report ID over a date range. | |
| Get Billing Report | get_report_billing | Retrieve billing report information for a master account. | |
| Get Cloud Recording Report | get_report_cloud_recording | Retrieve the cloud recording usage report for a date range (max 1 month span). | |
| Get Daily Usage Report | get_report_daily | Retrieve daily usage report (meetings, participants, meeting minutes) for a month. | |
| Get Meeting Activities Report | get_report_meeting_activities | Retrieve the meeting activities (device/join) report for a date range. | |
| Get Meeting Detail Report | get_report_meeting_details | Retrieve the detail report for a single past meeting. | |
| Get Meeting History Report | get_report_history_meetings | Retrieve the report of meetings held over a date range across the account. | |
| Get Meeting Participant Report | get_report_meeting_participants | Retrieve the participant report for a past meeting. | |
| Get Meeting Poll Report | get_report_meeting_polls | Retrieve poll results from a past meeting. | |
| Get Meeting Q&A Report | get_report_meeting_qa | Retrieve Q&A results from a past meeting. | |
| Get Meeting Survey Report | get_report_meeting_survey | Retrieve survey results from a past meeting. | |
| Get Operation Logs Report | get_report_operation_logs | Retrieve the operation logs report (admin activity) for a date range. | |
| Get Remote Support Report | get_report_remote_support | Retrieve the remote support session report for a date range (max 1 month span). | |
| Get Sign In/Out Activity Report | get_report_activities | Retrieve the sign in / sign out activity report for a date range. | |
| Get Sign-In Disclaimer Report | get_report_disclaimer | Retrieve the report of users who accepted a sign-in disclaimer. | |
| Get Telephone Report | get_report_telephone | Retrieve the telephone (Audio Conferencing/PSTN) usage report for a date range. | |
| Get Upcoming Events Report | get_report_upcoming_events | Retrieve a report of upcoming meetings and webinars over a date range. | |
| Get User Meeting Report | get_report_user_meetings | Retrieve meeting reports for a specific user over a date range (max 1 month span). | |
| Get Webinar Detail Report | get_report_webinar_details | Retrieve the detail report for a single past webinar. | |
| Get Webinar Participant Report | get_report_webinar_participants | Retrieve the participant report for a past webinar. | |
| Get Webinar Poll Report | get_report_webinar_polls | Retrieve poll results from a past webinar. | |
| Get Webinar Q&A Report | get_report_webinar_qa | Retrieve Q&A results from a past webinar. | |
| Get Webinar Survey Report | get_report_webinar_survey | Retrieve survey results from a past webinar. |
Revenue accelerator
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Conversation | zra_add_conversation | Add a conversation into Revenue Accelerator by file ID or third-party download URL. | |
| Add Conversation Comment | zra_add_comment | Add a comment to a specific conversation. | |
| Assign Team Managers | zra_assign_team_managers | Assign managers to a Revenue Accelerator team | |
| Assign Team Members | zra_assign_team_members | Assign members to a Revenue Accelerator team | |
| Create Team | zra_create_team | Create a Revenue Accelerator team | |
| Delete Conversation | zra_delete_conversation | Delete a Revenue Accelerator conversation by ID. | |
| Delete Conversation Comment | zra_delete_comment | Delete a comment from a specific conversation. | |
| Delete Deal Activity | zra_delete_deal_activity | Delete an activity from a Revenue Accelerator deal | |
| Delete Team | zra_delete_team | Delete a Revenue Accelerator team | |
| Edit Conversation Comment | zra_edit_comment | Edit a comment on a specific conversation. | |
| Get Content Analysis | zra_get_content_analysis | Get the content analysis (transcript-derived insights) for a conversation. | |
| Get Conversation | zra_get_conversation | Get information for a specific Revenue Accelerator conversation. | |
| Get CRM Settings | zra_get_crm_settings | Get current Revenue Accelerator CRM API registration | |
| Get CRM Task Result | zra_get_crm_task | Poll a Revenue Accelerator CRM async import task result | |
| Get Deal | zra_get_deal | Get Revenue Accelerator deal information | |
| Get Deal Activities | zra_get_deal_activities | Get activities for a Revenue Accelerator deal | |
| Get Indicators Settings | zra_get_indicators | Get Revenue Accelerator indicators (tracker/topic) settings | |
| Get Interactions | zra_get_interactions | Get interactions (engagement metrics) for a specific conversation. | |
| Get Scorecards | zra_get_scorecards | Get scorecards for a specific conversation. | |
| Get Team | zra_get_team | Get Revenue Accelerator team detail | |
| Grant Access From Teams | zra_grant_access_from | Grant target teams additional access to a Revenue Accelerator team | |
| Grant Access To Teams | zra_grant_access_to | Grant a Revenue Accelerator team additional access to target teams | |
| Import CRM Accounts | zra_import_crm_accounts | Bulk import CRM accounts into Zoom Revenue Accelerator. | |
| Import CRM Contacts | zra_import_crm_contacts | Bulk import CRM contacts into Zoom Revenue Accelerator. | |
| Import CRM Deals | zra_import_crm_deals | Bulk import CRM deals into Zoom Revenue Accelerator. | |
| Import CRM Leads | zra_import_crm_leads | Bulk import CRM leads into Zoom Revenue Accelerator. | |
| List Conversation Comments | zra_list_comments | List comments on a specific conversation. | |
| List Conversations | zra_list_conversations | List all Revenue Accelerator conversations/recordings. | |
| List CRM Accounts | zra_list_crm_accounts | List CRM accounts synced into Zoom Revenue Accelerator. | |
| List CRM Contacts | zra_list_crm_contacts | List CRM contacts synced into Zoom Revenue Accelerator. | |
| List CRM Deals | zra_list_crm_deals | List CRM deals synced into Zoom Revenue Accelerator. | |
| List CRM Leads | zra_list_crm_leads | List CRM leads synced into Zoom Revenue Accelerator. | |
| List Deal Activities | zra_list_deal_activities | List activities for a Zoom Revenue Accelerator deal. | |
| List Deals | zra_list_deals | List Revenue Accelerator deals | |
| List Scheduled Meetings | zra_list_scheduled | List Revenue Accelerator scheduled meetings | |
| List Team Managers | zra_list_team_managers | List managers of a Revenue Accelerator team | |
| List Team Members | zra_list_team_members | List members of a Revenue Accelerator team | |
| List Teams | zra_list_teams | List Revenue Accelerator account teams | |
| List Unassigned Team Users | zra_list_unassigned_team_users | List users not assigned to any Revenue Accelerator team | |
| Move Team | zra_move_team | Move a Revenue Accelerator team to a new parent | |
| Register CRM Connection | zra_register_crm | Register a Revenue Accelerator CRM API connection | |
| Remove Access From Teams | zra_remove_access_from | Remove target teams’ additional access to a Revenue Accelerator team | |
| Remove Access To Teams | zra_remove_access_to | Remove a Revenue Accelerator team’s additional access to target teams | |
| Unassign Team Managers | zra_unassign_team_managers | Unassign managers from a Revenue Accelerator team | |
| Unassign Team Members | zra_unassign_team_members | Unassign members from a Revenue Accelerator team | |
| Unregister CRM Connection | zra_unregister_crm | Unregister the Revenue Accelerator CRM API connection | |
| Update Conversation Host | zra_update_host | Update (reassign) the host of a Revenue Accelerator conversation. | |
| Update Team | zra_update_team | Update a Revenue Accelerator team’s name | |
| Upload File | zra_upload_file | Upload a recording, transcript, or metadata file to Revenue Accelerator (returns a file ID). |
Roles
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Assign Role Members | assign_role_members | Assign one or more members to a role. | |
| Create Role | create_role | Create a new account role. | |
| Delete Role | delete_role | Delete a role. | |
| Get Role | get_role | Get information about a specific role. | |
| List Role Members | list_role_members | List the members assigned to a role. | |
| List Roles | list_roles | List all account roles. | |
| Unassign Role Member | unassign_role_member | Unassign a member from a role. | |
| Update Role | update_role | Update an existing role. |
Scheduler
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Availability | create_scheduler_availability | Create a Zoom Scheduler availability schedule. | |
| Create Booking | create_scheduler_booking | Book a time slot on an existing Zoom Scheduler schedule. | |
| Create Schedule | create_scheduler_schedule | Create a Zoom Scheduler schedule (meeting type), optionally a single-use link. | |
| Delete Availability | delete_scheduler_availability | Delete a Zoom Scheduler availability schedule. | |
| Delete Schedule | delete_scheduler_schedule | Delete a Zoom Scheduler schedule. | |
| Delete Scheduled Event | delete_scheduled_event | Delete (cancel) a Zoom Scheduler scheduled event. | |
| Get Availability | get_scheduler_availability | Retrieve a Zoom Scheduler availability schedule. | |
| Get Event Attendee | get_scheduled_event_attendee | Retrieve an attendee of a Zoom Scheduler scheduled event. | |
| Get Routing Response | get_scheduler_routing_response | Retrieve a specific Zoom Scheduler routing form response. | |
| Get Schedule | get_scheduler_schedule | Retrieve a Zoom Scheduler schedule. | |
| Get Scheduled Event | get_scheduled_event | Retrieve a Zoom Scheduler scheduled event. | |
| List Availability | list_scheduler_availability | List Zoom Scheduler availability schedules. | |
| List Routing Responses | list_scheduler_routing_responses | List Zoom Scheduler routing form responses across all routing forms. | |
| List Scheduled Events | list_scheduled_events | List Zoom Scheduler scheduled events (bookings). | |
| List Schedules | list_scheduler_schedules | List Zoom Scheduler schedules (meeting types). | |
| Scheduler Analytics Report | scheduler_analytics | Generate the Zoom Scheduler analytics report. | |
| Update Availability | update_scheduler_availability | Update a Zoom Scheduler availability schedule. | |
| Update Schedule | update_scheduler_schedule | Update a Zoom Scheduler schedule. | |
| Update Scheduled Event | update_scheduled_event | Update a Zoom Scheduler scheduled event (status, attendees, notes). |
Team chat
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Legal Hold Matter | add_legal_hold_matter | Add a Team Chat legal hold matter. | |
| Add Mention Group Members | add_mention_group_members | Add members to a channel mention group. | |
| Add Shared Space Members | add_shared_space_members | Add members to a Team Chat shared space. | |
| Batch Add Chat Channel Members | batch_add_chat_channel_members | Batch add members to a Team Chat channel. | |
| Create Channel Mention Group | create_channel_mention_group | Create a mention group in a Team Chat channel. | |
| Create Chat Channel | create_chat_channel | Create a Team Chat channel for a user. | |
| Create Emoji Category | create_emoji_category | Create a custom Team Chat emoji category. | |
| Create Message Reminder | create_message_reminder | Create a reminder on a Team Chat message. | |
| Create Shared Space | create_shared_space | Create a Team Chat shared space. | |
| Delete Admin Channel | delete_admin_channel | Delete a Team Chat channel by ID (admin). | |
| Delete Channel Mention Group | delete_channel_mention_group | Delete a mention group from a Team Chat channel. | |
| Delete Chat Channel | delete_chat_channel | Delete a Team Chat channel. | |
| Delete Chat File | delete_chat_file | Delete a file from Team Chat. | |
| Delete Chat Message | delete_chat_message | Delete a Team Chat message. | |
| Delete Emoji Category | delete_emoji_category | Delete a custom Team Chat emoji category. | |
| Delete Legal Hold Matter | delete_legal_hold_matter | Delete a Team Chat legal hold matter. | |
| Delete Message Reminder | delete_message_reminder | Delete a reminder set on a Team Chat message. | |
| Delete Shared Space | delete_shared_space | Delete a Team Chat shared space. | |
| Demote Channel Administrators | demote_channel_administrators | Batch demote channel administrators back to members (admin). | |
| Demote Shared Space Admin | demote_shared_space_admin | Demote a shared space administrator to a member. | |
| Download Legal Hold Files | download_legal_hold_files | Download legal hold files for a given matter. | |
| Get Admin Channel | get_admin_channel | Get a Team Chat channel by ID (admin). | |
| Get Channel Mention Group | get_channel_mention_group | Get a mention group in a Team Chat channel. | |
| Get Chat Channel | get_chat_channel | Get information about a specific Team Chat channel. | |
| Get Chat File | get_chat_file | Get metadata for a single Team Chat file. | |
| Get Chat Message | get_chat_message | Retrieve a specific Team Chat message by ID. | |
| Get IM Message (Legacy) | get_im_message | Get a single message from a legacy IM chat session (deprecated API). | |
| Get IM Session (Legacy) | get_im_session | Get a legacy IM chat session’s messages (deprecated /im/chat/sessions API). | |
| Get Legal Hold Matter | get_legal_hold_matter | Get a Team Chat legal hold matter. | |
| Get Shared Space | get_shared_space | Get details of a Team Chat shared space. | |
| Invite Channel Members (Admin) | invite_channel_members_admin | Invite (add) members to a Team Chat channel (admin). | |
| Invite Chat Channel Members | invite_chat_channel_members | Invite/add members to a Team Chat channel. | |
| Join Chat Channel | join_chat_channel | Join a Team Chat channel as the current user. | |
| Leave Chat Channel | leave_chat_channel | Leave a Team Chat channel as the current user. | |
| List Account Channels | list_account_channels | List all Team Chat channels across the account (admin). | |
| List Category Emojis | list_category_emojis | List the custom emojis within a Team Chat emoji category. | |
| List Channel Administrators | list_channel_administrators | List the administrators of a Team Chat channel (admin). | |
| List Channel Members (Admin) | list_channel_members_admin | List the members of a Team Chat channel (admin). | |
| List Channel Mention Groups | list_channel_mention_groups | List the mention groups of a Team Chat channel. | |
| List Chat Channel Members | list_chat_channel_members | List the members of a Team Chat channel. | |
| List Chat Channels | list_chat_channels | List the Team Chat channels a user belongs to. | |
| List Chat Files | list_chat_files | List files sent/received by a Team Chat user. | |
| List Chat Messages | list_user_chat_messages | List a user’s Team Chat messages to/from a contact or in a channel. | |
| List Emoji Categories | list_emoji_categories | List an account’s custom Team Chat emoji categories. | |
| List Legal Hold Files | list_legal_hold_files | List legal hold files for a given matter. | |
| List Legal Hold Matters | list_legal_hold_matters | List Team Chat legal hold matters. | |
| List Mention Group Members | list_mention_group_members | List the members of a channel mention group. | |
| List Reminders | list_reminders | List a Team Chat user’s message reminders. | |
| List Scheduled Messages | list_scheduled_chat_messages | List a user’s scheduled Team Chat messages. | |
| List Shared Space Channels | list_shared_space_channels | List channels within a Team Chat shared space. | |
| List Shared Space Members | list_shared_space_members | List members of a Team Chat shared space. | |
| List Shared Spaces | list_shared_spaces | List all Team Chat shared spaces on the account. | |
| Mark Message Read/Unread | mark_chat_message_status | Mark a Team Chat message as read or unread. | |
| Move Shared Space Channels | move_shared_space_channels | Move channels into or out of a Team Chat shared space. | |
| Promote Channel Administrators | promote_channel_administrators | Batch promote channel members to administrators (admin). | |
| Promote Shared Space Admins | promote_shared_space_admins | Promote shared space members to administrators. | |
| React to Chat Message | react_chat_message | Add or remove an emoji reaction on a Team Chat message. | |
| Remove Channel Member (Admin) | remove_channel_member_admin | Remove a member from a Team Chat channel (admin). | |
| Remove Chat Channel Member | remove_chat_channel_member | Remove a single member from a Team Chat channel. | |
| Remove Mention Group Member | remove_mention_group_member | Remove a member from a channel mention group. | |
| Remove Shared Space Member | remove_shared_space_member | Remove a member from a Team Chat shared space. | |
| Search Account Channels | search_account_channels | Search the account’s Team Chat channels by keyword (admin). | |
| Search Chat Channels | search_chat_channels | Search Team Chat channels. | |
| Send Chat Channel Invitations | invite_chat_channel_invite | Send channel invitations to members of a Team Chat channel. | |
| Send Chat File | send_chat_file | Send (upload) a file into a Team Chat channel or to a contact. | |
| Send Chat Message | send_chat_message | Send a Team Chat message on behalf of a user. | |
| Send IM Message (Legacy) | send_im_message | Send a legacy IM chat message (deprecated /im/users/me/chat/messages API). | |
| Transfer Channel Owner | transfer_channel_owner | Transfer ownership of a Team Chat channel to another user (admin). | |
| Transfer Shared Space Ownership | transfer_shared_space_owner | Transfer ownership of a Team Chat shared space. | |
| Update Admin Channel | update_admin_channel | Update a Team Chat channel’s name/settings (admin). | |
| Update Channel Mention Group | update_channel_mention_group | Update a mention group in a Team Chat channel. | |
| Update Chat Channel | update_chat_channel | Update a Team Chat channel’s name or settings. | |
| Update Chat Message | update_chat_message | Edit the text of an existing Team Chat message. | |
| Update Legal Hold Matter | update_legal_hold_matter | Update a Team Chat legal hold matter. | |
| Update Shared Space | update_shared_space | Update settings of a Team Chat shared space. |
Triggers
| Operation | ID | Description | Trigger |
|---|---|---|---|
| On Account Settings Updated | on_account_settings_updated | Fires on the Zoom `account.settings_updated` webhook event. | Yes |
| On Account Updated | on_account_updated | Fires on the Zoom `account.updated` webhook event. | Yes |
| On Account Vanity URL Updated | on_account_vanity_url_updated | Fires on the Zoom `account.vanity_url_updated` webhook event. | Yes |
| On Any Zoom Event | on_any_zoom_event | Fires on any Zoom webhook event delivered to this URL. | Yes |
| On Breakout Room Ended | on_meeting_breakout_room_ended | Fires on the Zoom `meeting.breakout_room_ended` webhook event. | Yes |
| On Breakout Room Started | on_meeting_breakout_room_started | Fires on the Zoom `meeting.breakout_room_started` webhook event. | Yes |
| On Chat Channel Created | on_chat_channel_created | Fires on the Zoom `chat_channel.created` webhook event. | Yes |
| On Chat Channel Deleted | on_chat_channel_deleted | Fires on the Zoom `chat_channel.deleted` webhook event. | Yes |
| On Chat Channel Member Invited | on_chat_channel_member_invited | Fires on the Zoom `chat_channel.member_invited` webhook event. | Yes |
| On Chat Channel Member Joined | on_chat_channel_member_joined | Fires on the Zoom `chat_channel.member_joined` webhook event. | Yes |
| On Chat Channel Member Left | on_chat_channel_member_left | Fires on the Zoom `chat_channel.member_left` webhook event. | Yes |
| On Chat Channel Updated | on_chat_channel_updated | Fires on the Zoom `chat_channel.updated` webhook event. | Yes |
| On Chat Message Deleted | on_chat_message_deleted | Fires on the Zoom `chat_message.deleted` webhook event. | Yes |
| On Chat Message Sent | on_chat_message_sent | Fires on the Zoom `chat_message.sent` webhook event. | Yes |
| On Chat Message Updated | on_chat_message_updated | Fires on the Zoom `chat_message.updated` webhook event. | Yes |
| On Meeting Alert | on_meeting_alert | Fires on the Zoom `meeting.alert` webhook event. | Yes |
| On Meeting Chat Message Sent | on_meeting_chat_message_sent | Fires on the Zoom `meeting.chat_message_sent` webhook event. | Yes |
| On Meeting Created | on_meeting_created | Fires on the Zoom `meeting.created` webhook event. | Yes |
| On Meeting Deleted | on_meeting_deleted | Fires on the Zoom `meeting.deleted` webhook event. | Yes |
| On Meeting Ended | on_meeting_ended | Fires on the Zoom `meeting.ended` webhook event. | Yes |
| On Meeting Live Streaming Started | on_meeting_live_streaming_started | Fires on the Zoom `meeting.live_streaming_started` webhook event. | Yes |
| On Meeting Live Streaming Stopped | on_meeting_live_streaming_stopped | Fires on the Zoom `meeting.live_streaming_stopped` webhook event. | Yes |
| On Meeting Participant Joined | on_meeting_participant_joined | Fires on the Zoom `meeting.participant_joined` webhook event. | Yes |
| On Meeting Participant Left | on_meeting_participant_left | Fires on the Zoom `meeting.participant_left` webhook event. | Yes |
| On Meeting Permanently Deleted | on_meeting_permanently_deleted | Fires on the Zoom `meeting.permanently_deleted` webhook event. | Yes |
| On Meeting Registration Approved | on_meeting_registration_approved | Fires on the Zoom `meeting.registration_approved` webhook event. | Yes |
| On Meeting Registration Cancelled | on_meeting_registration_cancelled | Fires on the Zoom `meeting.registration_cancelled` webhook event. | Yes |
| On Meeting Registration Created | on_meeting_registration_created | Fires on the Zoom `meeting.registration_created` webhook event. | Yes |
| On Meeting Registration Denied | on_meeting_registration_denied | Fires on the Zoom `meeting.registration_denied` webhook event. | Yes |
| On Meeting Risk Alert | on_meeting_risk_alert | Fires on the Zoom `meeting.risk_alert` webhook event. | Yes |
| On Meeting Sharing Ended | on_meeting_sharing_ended | Fires on the Zoom `meeting.sharing_ended` webhook event. | Yes |
| On Meeting Sharing Started | on_meeting_sharing_started | Fires on the Zoom `meeting.sharing_started` webhook event. | Yes |
| On Meeting Started | on_meeting_started | Fires on the Zoom `meeting.started` webhook event. | Yes |
| On Meeting Summary Completed | on_meeting_summary_completed | Fires on the Zoom `meeting.summary_completed` webhook event. | Yes |
| On Meeting Updated | on_meeting_updated | Fires on the Zoom `meeting.updated` webhook event. | Yes |
| On Participant Admitted | on_meeting_participant_admitted | Fires on the Zoom `meeting.participant_admitted` webhook event. | Yes |
| On Participant JBH Joined | on_meeting_participant_jbh_joined | Fires on the Zoom `meeting.participant_jbh_joined` webhook event. | Yes |
| On Participant JBH Waiting | on_meeting_participant_jbh_waiting | Fires on the Zoom `meeting.participant_jbh_waiting` webhook event. | Yes |
| On Participant Joined Waiting Room | on_meeting_participant_joined_waiting_room | Fires on the Zoom `meeting.participant_joined_waiting_room` webhook event. | Yes |
| On Participant Left Waiting Room | on_meeting_participant_left_waiting_room | Fires on the Zoom `meeting.participant_left_waiting_room` webhook event. | Yes |
| On Participant Put In Waiting Room | on_meeting_participant_put_in_waiting_room | Fires on the Zoom `meeting.participant_put_in_waiting_room` webhook event. | Yes |
| On Participant Role Changed | on_meeting_participant_role_changed | Fires on the Zoom `meeting.participant_role_changed` webhook event. | Yes |
| On Phone Callee Answered | on_phone_callee_answered | Fires on the Zoom `phone.callee_answered` webhook event. | Yes |
| On Phone Callee Ended | on_phone_callee_ended | Fires on the Zoom `phone.callee_ended` webhook event. | Yes |
| On Phone Callee Missed | on_phone_callee_missed | Fires on the Zoom `phone.callee_missed` webhook event. | Yes |
| On Phone Callee Rejected | on_phone_callee_rejected | Fires on the Zoom `phone.callee_rejected` webhook event. | Yes |
| On Phone Caller Connected | on_phone_caller_connected | Fires on the Zoom `phone.caller_connected` webhook event. | Yes |
| On Phone Caller Ended | on_phone_caller_ended | Fires on the Zoom `phone.caller_ended` webhook event. | Yes |
| On Phone Emergency Alert | on_phone_emergency_alert | Fires on the Zoom `phone.emergency_alert` webhook event. | Yes |
| On Phone Recording Completed | on_phone_recording_completed | Fires on the Zoom `phone.recording_completed` webhook event. | Yes |
| On Phone Recording Started | on_phone_recording_started | Fires on the Zoom `phone.recording_started` webhook event. | Yes |
| On Phone Recording Stopped | on_phone_recording_stopped | Fires on the Zoom `phone.recording_stopped` webhook event. | Yes |
| On Phone SMS Received | on_phone_sms_received | Fires on the Zoom `phone.sms_received` webhook event. | Yes |
| On Phone SMS Sent | on_phone_sms_sent | Fires on the Zoom `phone.sms_sent` webhook event. | Yes |
| On Phone Voicemail Received | on_phone_voicemail_received | Fires on the Zoom `phone.voicemail_received` webhook event. | Yes |
| On Phone Voicemail Transcript Completed | on_phone_voicemail_transcript_completed | Fires on the Zoom `phone.voicemail_transcript_completed` webhook event. | Yes |
| On Recording Batch Deleted | on_recording_batch_deleted | Fires on the Zoom `recording.batch_deleted` webhook event. | Yes |
| On Recording Completed | on_recording_completed | Fires on the Zoom `recording.completed` webhook event. | Yes |
| On Recording Deleted | on_recording_deleted | Fires on the Zoom `recording.deleted` webhook event. | Yes |
| On Recording Paused | on_recording_paused | Fires on the Zoom `recording.paused` webhook event. | Yes |
| On Recording Recovered | on_recording_recovered | Fires on the Zoom `recording.recovered` webhook event. | Yes |
| On Recording Registration Approved | on_recording_registration_approved | Fires on the Zoom `recording.registration_approved` webhook event. | Yes |
| On Recording Registration Created | on_recording_registration_created | Fires on the Zoom `recording.registration_created` webhook event. | Yes |
| On Recording Resumed | on_recording_resumed | Fires on the Zoom `recording.resumed` webhook event. | Yes |
| On Recording Started | on_recording_started | Fires on the Zoom `recording.started` webhook event. | Yes |
| On Recording Stopped | on_recording_stopped | Fires on the Zoom `recording.stopped` webhook event. | Yes |
| On Recording Transcript Completed | on_recording_transcript_completed | Fires on the Zoom `recording.transcript_completed` webhook event. | Yes |
| On Recording Trashed | on_recording_trashed | Fires on the Zoom `recording.trashed` webhook event. | Yes |
| On Sub-Account Created | on_account_created | Fires on the Zoom `account.created` webhook event. | Yes |
| On Sub-Account Disassociated | on_account_disassociated | Fires on the Zoom `account.disassociated` webhook event. | Yes |
| On User Activated | on_user_activated | Fires on the Zoom `user.activated` webhook event. | Yes |
| On User Created | on_user_created | Fires on the Zoom `user.created` webhook event. | Yes |
| On User Deactivated | on_user_deactivated | Fires on the Zoom `user.deactivated` webhook event. | Yes |
| On User Deleted | on_user_deleted | Fires on the Zoom `user.deleted` webhook event. | Yes |
| On User Disassociated | on_user_disassociated | Fires on the Zoom `user.disassociated` webhook event. | Yes |
| On User Invitation Accepted | on_user_invitation_accepted | Fires on the Zoom `user.invitation_accepted` webhook event. | Yes |
| On User Personal Notes Updated | on_user_personal_notes_updated | Fires on the Zoom `user.personal_notes_updated` webhook event. | Yes |
| On User Presence Status Updated | on_user_presence_status_updated | Fires on the Zoom `user.presence_status_updated` webhook event. | Yes |
| On User Settings Updated | on_user_settings_updated | Fires on the Zoom `user.settings_updated` webhook event. | Yes |
| On User Signed In | on_user_signed_in | Fires on the Zoom `user.signed_in` webhook event. | Yes |
| On User Signed Out | on_user_signed_out | Fires on the Zoom `user.signed_out` webhook event. | Yes |
| On User Updated | on_user_updated | Fires on the Zoom `user.updated` webhook event. | Yes |
| On Webinar Alert | on_webinar_alert | Fires on the Zoom `webinar.alert` webhook event. | Yes |
| On Webinar Created | on_webinar_created | Fires on the Zoom `webinar.created` webhook event. | Yes |
| On Webinar Deleted | on_webinar_deleted | Fires on the Zoom `webinar.deleted` webhook event. | Yes |
| On Webinar Ended | on_webinar_ended | Fires on the Zoom `webinar.ended` webhook event. | Yes |
| On Webinar Participant Joined | on_webinar_participant_joined | Fires on the Zoom `webinar.participant_joined` webhook event. | Yes |
| On Webinar Participant Left | on_webinar_participant_left | Fires on the Zoom `webinar.participant_left` webhook event. | Yes |
| On Webinar Registration Approved | on_webinar_registration_approved | Fires on the Zoom `webinar.registration_approved` webhook event. | Yes |
| On Webinar Registration Cancelled | on_webinar_registration_cancelled | Fires on the Zoom `webinar.registration_cancelled` webhook event. | Yes |
| On Webinar Registration Created | on_webinar_registration_created | Fires on the Zoom `webinar.registration_created` webhook event. | Yes |
| On Webinar Registration Denied | on_webinar_registration_denied | Fires on the Zoom `webinar.registration_denied` webhook event. | Yes |
| On Webinar Sharing Ended | on_webinar_sharing_ended | Fires on the Zoom `webinar.sharing_ended` webhook event. | Yes |
| On Webinar Sharing Started | on_webinar_sharing_started | Fires on the Zoom `webinar.sharing_started` webhook event. | Yes |
| On Webinar Started | on_webinar_started | Fires on the Zoom `webinar.started` webhook event. | Yes |
| On Webinar Updated | on_webinar_updated | Fires on the Zoom `webinar.updated` webhook event. | Yes |
Users
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add User Assistants | add_user_assistants | Add assistants to a user. | |
| Add User TSP Account | add_user_tsp_account | Add a TSP account to a user. | |
| Check User Email | check_user_email | Check whether a user’s email is already registered on Zoom. | |
| Check Vanity Name | check_vanity_name | Check whether a Personal Meeting Room vanity name is available. | |
| Create User | create_user | Add/create a user on the account. | |
| Delete All User Assistants | delete_user_assistants | Delete all of a user’s assistants. | |
| Delete All User Schedulers | delete_user_schedulers | Delete all of a user’s schedulers. | |
| Delete User | delete_user | Delete/deactivate a user. | |
| Delete User Assistant | delete_user_assistant | Delete a single assistant from a user. | |
| Delete User Picture | delete_user_picture | Delete a user’s profile picture. | |
| Delete User Scheduler | delete_user_scheduler | Delete a single scheduler from a user. | |
| Delete User TSP Account | delete_user_tsp_account | Delete a user’s TSP account. | |
| Delete Virtual Background | delete_virtual_background | Delete one or more virtual background files from a user’s settings. | |
| Get Collaboration Device | get_collaboration_device | Get a user’s collaboration device by device ID. | |
| Get User | get_user | Retrieve a user’s profile. | |
| Get User Permissions | get_user_permissions | Get a user’s assigned permissions. | |
| Get User Settings | get_user_settings | Retrieve a user’s Zoom settings (meeting, recording, telephony, feature, TSP, profile). | |
| Get User Token | get_user_token | Retrieve a user’s token or ZAK (Zoom Access Key) used to start meetings on their behalf. | |
| Get User TSP Account | get_user_tsp_account | Get a user’s TSP account by TSP bridge ID. | |
| Get User ZAK | get_user_zak | Retrieve a user’s ZAK (Zoom Access Key) to start meetings/webinars on their behalf. | |
| List Collaboration Devices | list_collaboration_devices | List a user’s collaboration devices. | |
| List User Assistants | list_user_assistants | List a user’s assistants. | |
| List User PAC Accounts | list_user_pac_accounts | List a user’s PAC (Personal Audio Conference) accounts. | |
| List User Schedulers | list_user_schedulers | List a user’s schedulers. | |
| List User TSP Accounts | list_user_tsp_accounts | List a user’s TSP (Telephony Service Provider) accounts. | |
| List Users | list_users | List users on the account. | |
| Revoke User Token | revoke_user_token | Revoke a user’s SSO token, logging the user out of all Zoom clients. | |
| Switch User Account | switch_user_account | Move a user from one sub-account to another (master account only). | |
| Update Presence Status | update_presence_status | Update a user’s presence status (e.g. Do Not Disturb, Away, Available). | |
| Update User | update_user | Update a user’s profile/settings. | |
| Update User Email | update_user_email | Change a user’s email address. | |
| Update User Password | update_user_password | Change a user’s login password. | |
| Update User Settings | update_user_settings | Update a user’s Zoom settings via a JSON body (schedule_meeting, recording, telephony, feature, etc.). | |
| Update User Status | update_user_status | Activate or deactivate a user. | |
| Update User TSP Account | update_user_tsp_account | Update a user’s TSP account. | |
| Upload User Picture | upload_user_picture | Upload a user’s profile picture (multipart form field ‘pic_file’). | |
| Upload Virtual Background | upload_virtual_background | Upload a virtual background image to a user’s settings (multipart form field ‘file’). |
Video SDK
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cloud Recording Report | videosdk_report_cloud_recording | Get a Video SDK cloud recording usage report. | |
| Create Session | videosdk_create_session | Create a Zoom Video SDK session. | |
| Create Storage Location | videosdk_create_storage_location | Create a Video SDK BYOS storage location (Amazon S3). | |
| Daily Usage Report | videosdk_report_daily | Get a Video SDK daily usage report (sessions/participants per day). | |
| Delete Recording File | videosdk_delete_recording_file | Delete a single recording file from a Video SDK session. | |
| Delete Session | videosdk_delete_session | Delete a Zoom Video SDK session. | |
| Delete Session Recordings | videosdk_delete_session_recordings | Delete all recordings of a Video SDK session. | |
| Delete Storage Location | videosdk_delete_storage_location | Delete a Video SDK BYOS storage location. | |
| Get Live Stream Details | videosdk_get_livestream | Get a Video SDK session’s live stream details. | |
| Get Session Details | videosdk_get_session | Get details of a Zoom Video SDK session. | |
| Get Session Recordings | videosdk_get_session_recordings | Get all recordings of a Video SDK session. | |
| Get Session Sharing/Recording Details | videosdk_get_session_sharing | Get screen-sharing and recording details for a session’s users. | |
| Get Session SIP URI | videosdk_get_sip_uri | Get a Video SDK session’s SIP URI (with optional embedded passcode) for SIP dialing. | |
| Get Session User QoS | videosdk_get_session_user_qos | Get QoS (quality of service) data for a single user in a session. | |
| Get Storage Location | videosdk_get_storage_location | Get details of a Video SDK BYOS storage location. | |
| In-Session Events Control | videosdk_in_session_events | Use in-session event controls on a live Video SDK session (recording, invites, block/unblock, stream ingestion, remove user). | |
| List Account Recordings | videosdk_list_recordings | List all Video SDK cloud recordings for the account. | |
| List Session Recordings | videosdk_list_session_recordings | List a Video SDK session’s cloud recordings. | |
| List Session Stream Ingestions | videosdk_list_stream_ingestions | List a Video SDK session’s streaming ingestions. | |
| List Session Users | videosdk_list_session_users | List users of a Zoom Video SDK session. | |
| List Session Users QoS | videosdk_list_session_users_qos | List QoS (quality of service) data for all users in a session. | |
| List Sessions | videosdk_list_sessions | List Zoom Video SDK sessions in a date range. | |
| List Storage Locations | videosdk_list_storage_locations | List the account’s Video SDK BYOS storage locations. | |
| Operation Logs Report | videosdk_report_operation_logs | Get a Video SDK operation logs report. | |
| Recover Recording File | videosdk_recover_recording_file | Recover a single Video SDK session recording file from the trash. | |
| Recover Session Recordings | videosdk_recover_session_recordings | Recover all recordings of a Video SDK session from the trash. | |
| Switch BYOS Storage | videosdk_switch_storage | Switch the account’s Video SDK BYOS storage on/off and select a location. | |
| Telephone Report | videosdk_report_telephone | Get a Video SDK telephone (dial-in/out) usage report. | |
| Update Live Stream | videosdk_update_livestream | Update (configure) a Video SDK session’s live stream URL/key. | |
| Update Live Stream Status | videosdk_update_livestream_status | Start/stop a Video SDK session’s live stream or change its display mode. | |
| Update RTMS App Status | videosdk_update_rtms_status | Update a session’s Realtime Media Streams (RTMS) app status. | |
| Update Session Status | videosdk_update_session_status | Update a Video SDK session’s status (e.g. end the session). | |
| Update Storage Location | videosdk_update_storage_location | Update a Video SDK BYOS storage location. | |
| Webhook Logs Report | videosdk_report_webhook_logs | Get a Video SDK webhook delivery logs report. |
Webinars
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Webinar Panelists | add_webinar_panelists | Add one or more panelists to a webinar. | |
| Add Webinar Registrant | add_webinar_registrant | Register a user for a webinar. | |
| Batch Add Webinar Registrants | batch_add_webinar_registrants | Register up to 30 registrants for a webinar at once. | |
| Create Webinar | create_webinar | Schedule a new webinar. | |
| Create Webinar Branding Name Tag | create_webinar_branding_name_tag | Create a session branding name tag for a webinar. | |
| Create Webinar Invite Links | create_webinar_invite_links | Create one or more attendee join links for a webinar. | |
| Create Webinar Poll | create_webinar_poll | Create a poll for a webinar. | |
| Create Webinar Template | create_webinar_template | Create a webinar template from an existing webinar. | |
| Delete Webinar | delete_webinar | Delete a webinar. | |
| Delete Webinar Branding Banner | delete_webinar_branding_banner | Delete a session branding banner from a webinar. | |
| Delete Webinar Branding Name Tags | delete_webinar_branding_name_tags | Delete session branding name tags from a webinar. | |
| Delete Webinar Branding Virtual Backgrounds | delete_webinar_branding_virtual_backgrounds | Delete session branding virtual backgrounds from a webinar. | |
| Delete Webinar Branding Wallpaper | delete_webinar_branding_wallpaper | Delete a webinar’s session branding wallpaper. | |
| Delete Webinar Poll | delete_webinar_poll | Delete a specific poll of a webinar. | |
| Delete Webinar Registrant | delete_webinar_registrant | Delete a webinar registrant. | |
| Delete Webinar Survey | delete_webinar_survey | Delete a webinar’s survey. | |
| Get Webinar | get_webinar | Retrieve details of a webinar. | |
| Get Webinar Absentees | get_webinar_absentees | List registrants who did not attend a past webinar (absentees). | |
| Get Webinar Branding | get_webinar_branding | Get a webinar’s session branding assets. | |
| Get Webinar Live Stream | get_webinar_livestream | Get a webinar’s live stream configuration. | |
| Get Webinar Live Streaming Token | get_webinar_live_streaming_token | Get a join token to start a webinar’s live streaming. | |
| Get Webinar Local Recording Token | get_webinar_local_recording_token | Get a join token for a webinar’s local recording. | |
| Get Webinar Poll | get_webinar_poll | Get a specific poll of a webinar. | |
| Get Webinar Registrant | get_webinar_registrant | Get details of a specific webinar registrant. | |
| Get Webinar Registration Questions | get_webinar_registration_questions | Get the registration questions configured for a webinar. | |
| Get Webinar Survey | get_webinar_survey | Get a webinar’s survey configuration. | |
| List Past Webinar Instances | list_past_webinar_instances | List past instances of a webinar. | |
| List Past Webinar Participants | list_past_webinar_participants | List participants of a past webinar instance. | |
| List Past Webinar Polls | list_past_webinar_polls | List poll results of a past webinar. | |
| List Past Webinar Q&A | list_past_webinar_qa | List Q&A results of a past webinar. | |
| List Webinar Panelists | list_webinar_panelists | List all panelists of a webinar. | |
| List Webinar Polls | list_webinar_polls | List all polls of a webinar. | |
| List Webinar Registrants | list_webinar_registrants | List registrants of a webinar. | |
| List Webinar Templates | list_webinar_templates | List a user’s webinar templates. | |
| List Webinar Tracking Sources | list_webinar_tracking_sources | List tracking sources (registration/join counts) for a webinar. | |
| List Webinars | list_webinars | List webinars for a user (Webinar add-on required). | |
| Remove All Webinar Panelists | remove_all_webinar_panelists | Remove all panelists from a webinar. | |
| Remove Webinar Panelist | remove_webinar_panelist | Remove a single panelist from a webinar. | |
| Set Webinar Branding Virtual Background Status | set_webinar_branding_virtual_background_status | Set the default session branding virtual background for a webinar. | |
| Update Webinar | update_webinar | Update a webinar’s settings. | |
| Update Webinar Branding Name Tag | update_webinar_branding_name_tag | Update a session branding name tag for a webinar. | |
| Update Webinar Live Stream | update_webinar_livestream | Update a webinar’s live stream configuration. | |
| Update Webinar Live Stream Status | update_webinar_livestream_status | Start or stop a webinar’s live stream. | |
| Update Webinar Poll | update_webinar_poll | Update a specific poll of a webinar. | |
| Update Webinar Registrant Status | update_webinar_registrant_status | Approve, deny, or cancel webinar registrants. | |
| Update Webinar Registration Questions | update_webinar_registration_questions | Update the registration questions for a webinar. | |
| Update Webinar Status | update_webinar_status | End a live webinar (update its status). | |
| Update Webinar Survey | update_webinar_survey | Update (create/replace) a webinar’s survey. | |
| Upload Webinar Branding Banner | upload_webinar_branding_banner | Upload a session branding banner for a webinar. | |
| Upload Webinar Branding Virtual Background | upload_webinar_branding_virtual_background | Upload a session branding virtual background for a webinar. | |
| Upload Webinar Branding Wallpaper | upload_webinar_branding_wallpaper | Upload a session branding wallpaper for a webinar. |
Whiteboard
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Whiteboard | create_whiteboard | Create a new whiteboard. | |
| Create Whiteboard Export | create_whiteboard_export | Create a whiteboard export task. | |
| Create Whiteboard Project | create_whiteboard_project | Create a new whiteboard project. | |
| Delete Whiteboard | delete_whiteboard | Delete a whiteboard. | |
| Delete Whiteboard Project | delete_whiteboard_project | Delete a whiteboard project. | |
| Download Whiteboard Activity File | download_whiteboard_activity_file | Download a whiteboard session activity file. | |
| Download Whiteboard Export | download_whiteboard_export | Download a completed whiteboard export. | |
| Download Whiteboard File | download_whiteboard_file | Download an imported whiteboard file. | |
| Get Project Collaborators | get_project_collaborators | Get collaborators of a whiteboard project. | |
| Get Whiteboard | get_whiteboard | Get a single whiteboard’s details. | |
| Get Whiteboard Collaborators | get_whiteboard_collaborators | Get collaborators of a whiteboard. | |
| Get Whiteboard Export Status | get_whiteboard_export_status | Get the generation status of a whiteboard export task. | |
| Get Whiteboard Import Status | get_whiteboard_import_status | Get the status of a whiteboard import task. | |
| Get Whiteboard Project | get_whiteboard_project | Get a single whiteboard project. | |
| Import Whiteboard | import_whiteboard | Create a new whiteboard by importing an uploaded file. | |
| List Whiteboard Projects | list_whiteboard_projects | List all whiteboard projects. | |
| List Whiteboard Session Activities | list_whiteboard_session_activities | List activities for a whiteboard session. | |
| List Whiteboard Sessions | list_whiteboard_sessions | List whiteboard sessions within a date range. | |
| List Whiteboard Subprojects | list_whiteboard_subprojects | List subprojects of a whiteboard project. | |
| List Whiteboards | list_whiteboards | List all whiteboards owned by or shared with a user. | |
| Move Whiteboards To Project | move_whiteboards_to_project | Move whiteboards into a project. | |
| Remove Project Collaborator | remove_project_collaborator | Remove a collaborator from a whiteboard project. | |
| Remove Whiteboard Collaborator | remove_whiteboard_collaborator | Remove a collaborator from a whiteboard. | |
| Remove Whiteboards From Project | remove_whiteboards_from_project | Remove whiteboards from a project. | |
| Share Whiteboard | share_whiteboard | Share a whiteboard with new users or team chat channels. | |
| Share Whiteboard Project | share_whiteboard_project | Share a whiteboard project with new users. | |
| Update Project Collaborators | update_project_collaborators | Update whiteboard project collaborators. | |
| Update Whiteboard | update_whiteboard | Update a whiteboard’s basic information. | |
| Update Whiteboard Collaborators | update_whiteboard_collaborators | Update whiteboard collaborators’ roles/access. | |
| Update Whiteboard Project | update_whiteboard_project | Update a whiteboard project’s basic information. | |
| Update Whiteboard Share Setting | update_whiteboard_share_setting | Update a whiteboard’s share settings. | |
| Upload Whiteboard File | upload_whiteboard_file | Upload a file for whiteboard import. |
Workforce management
| Operation | ID | Description | Trigger |
|---|---|---|---|
| WFM: Create Organizational Group | wfm_create_organizational_group | Create an organizational group | |
| WFM: Delete Historical Agent Status | wfm_delete_historical_agent_status | Delete historical agent status data | |
| WFM: Delete Organizational Group | wfm_delete_organizational_group | Delete an organizational group | |
| WFM: Get Forecast For Scheduling Group | wfm_get_forecast | Get a forecast for a specific scheduling group | |
| WFM: Get Organizational Group | wfm_get_organizational_group | Get a single organizational group | |
| WFM: Get Queue Metrics Import | wfm_get_queue_metrics_import | Get metadata for a historical queue metrics import | |
| WFM: Import Historical Agent Status | wfm_import_historical_agent_status | Upload historical agent status data | |
| WFM: Import Historical Queue Metrics | wfm_import_historical_queue_metrics | Upload historical queue metrics | |
| WFM: List Agent Adherence | wfm_list_agent_adherence | List agents’ adherence data | |
| WFM: List Filter Groups | wfm_list_filter_groups | List all Workforce Management filter groups | |
| WFM: List Forecasts | wfm_list_forecasts | List Workforce Management forecasts | |
| WFM: List Organizational Groups | wfm_list_organizational_groups | List all organizational groups | |
| WFM: List Schedule Report Agents | wfm_list_schedule_report_agents | List scheduled agents from the schedules report | |
| WFM: List Scheduled Agents | wfm_list_scheduled_agents | List scheduled agents with shifts and activities for a date | |
| WFM: List Scheduling Groups | wfm_list_scheduling_groups | List all scheduling groups | |
| WFM: List Users | wfm_list_users | List all Workforce Management account users | |
| WFM: Update Organizational Group | wfm_update_organizational_group | Update an organizational group |
Zoom calendar
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create ACL Rule | calendar_insert_acl | Create an access control rule on a calendar. | |
| Create Calendar | calendar_create_calendar | Create a secondary calendar. | |
| Create Calendar Event | calendar_create_event | Create an event on a Zoom calendar. | |
| Delete ACL Rule | calendar_delete_acl | Delete an access control rule from a calendar. | |
| Delete Calendar | calendar_delete_calendar | Delete a secondary calendar. | |
| Delete Calendar Event | calendar_delete_event | Delete an event from a Zoom calendar. | |
| Delete Calendar List Entry | calendar_delete_calendar_list | Remove a calendar from a user’s calendar list. | |
| Get ACL Rule | calendar_get_acl | Get a single access control rule from a calendar. | |
| Get Calendar | calendar_get_calendar | Get a calendar’s metadata. | |
| Get Calendar Event | calendar_get_event | Retrieve a single event from a Zoom calendar. | |
| Get Calendar List Entry | calendar_get_calendar_list | Get a single entry from a user’s calendar list. | |
| Get Colors | calendar_get_colors | Get the color definitions for calendars and events. | |
| Import Calendar Event | calendar_import_event | Import an event into a Zoom calendar (private copy of an existing event). | |
| Insert Calendar List Entry | calendar_insert_calendar_list | Insert an existing calendar onto a user’s calendar list. | |
| List ACL Rules | calendar_list_acl | List the access control rules for a calendar. | |
| List Calendar Event Instances | calendar_list_event_instances | List the instances of a recurring event. | |
| List Calendar Events | calendar_list_events | List events on the specified Zoom calendar. | |
| List Calendar List | calendar_list_calendar_list | List the calendars on a user’s calendar list. | |
| Move Calendar Event | calendar_move_event | Move an event to another calendar (changes the organizer). | |
| Patch Calendar Event | calendar_patch_event | Partially update an event on a Zoom calendar. | |
| Quick Add Calendar Event | calendar_quick_add_event | Create an event from a simple text string. | |
| Stop Watch Channel | calendar_stop_watch | Stop watching a resources channel (terminate a push notification channel). | |
| Update ACL Rule | calendar_update_acl | Update an access control rule on a calendar. | |
| Update Calendar | calendar_update_calendar | Update a calendar’s metadata. | |
| Update Calendar Event | calendar_update_event | Update (full replace) an event on a Zoom calendar. | |
| Update Calendar List Entry | calendar_update_calendar_list | Update an entry on a user’s calendar list. | |
| Watch Calendar Events | calendar_watch_events | Watch for changes to events resources on a calendar (push notification channel). |
Zoom clips
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Collaborators | clips_add_collaborators | Add collaborators to a Zoom Clip. | |
| Create Chapters | clips_create_chapters | Create or replace the chapters of a Zoom Clip. | |
| Delete Clip | clips_delete_clip | Delete a Zoom Clip. | |
| Delete Comment | clips_delete_comment | Delete a comment on a Zoom Clip. | |
| Download Clip | clips_download_clip | Get the download information for a Zoom Clip. | |
| Duplicate Clip | clips_duplicate_clip | Duplicate a Zoom Clip. | |
| Get Chapters | clips_get_chapters | Get the chapters of a Zoom Clip. | |
| Get Clip | clips_get_clip | Get details of a specific Zoom Clip. | |
| Get Transfer Status | clips_get_transfer_status | Check the status of a Zoom Clips ownership transfer task. | |
| List Clips | clips_list_clips | List all Zoom Clips for a user. | |
| List Collaborators | clips_list_collaborators | List the collaborators of a Zoom Clip. | |
| List Comments | clips_list_comments | List the comments on a Zoom Clip. | |
| Multipart Upload Events | clips_multipart_upload_events | Manage multipart upload events (create/complete) for a Zoom Clip file. | |
| Remove Collaborators | clips_remove_collaborators | Remove collaborators from a Zoom Clip. | |
| Transfer Ownership | clips_transfer_ownership | Transfer ownership of Zoom Clips from one user to another. | |
| Update Clip | clips_update_clip | Update the metadata of a Zoom Clip. | |
| Update Share Settings | clips_update_share_settings | Update the share settings of a Zoom Clip. |
Zoom events
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cancel Event | zoom_events_cancel_event | Cancel a published Zoom Event (host action). | |
| Create Access Link | zoom_events_create_access_link | Create an access link for an event. | |
| Create Event | zoom_events_create_event | Create a Zoom Events event within a hub. | |
| Create Exhibitor | zoom_events_create_exhibitor | Create an exhibitor/sponsor for an event. | |
| Create Hub Host | zoom_events_create_hub_host | Add one or more hosts to a Zoom Events hub. | |
| Create Session | zoom_events_create_session | Create a session in a Zoom Event (not for single-session events). | |
| Create Session Reservation | zoom_events_create_session_reservation | Reserve a session spot for a user by email. | |
| Create Speaker | zoom_events_create_speaker | Create a speaker for a Zoom Event. | |
| Create Ticket Type | zoom_events_create_ticket_type | Create a ticket type for a Zoom Event. | |
| Create Tickets | zoom_events_create_tickets | Issue tickets (register attendees) for an event. | |
| Delete Access Link | zoom_events_delete_access_link | Delete an event access link. | |
| Delete Event | zoom_events_delete_event | Delete a Zoom Events event. | |
| Delete Exhibitor | zoom_events_delete_exhibitor | Delete an exhibitor. | |
| Delete Session | zoom_events_delete_session | Delete a session from a Zoom Event. | |
| Delete Session Reservation | zoom_events_delete_session_reservation | Delete a session reservation for a user by email. | |
| Delete Speaker | zoom_events_delete_speaker | Delete a speaker from a Zoom Event. | |
| Delete Ticket | zoom_events_delete_ticket | Delete (cancel) a ticket for a Zoom Event. | |
| Delete Ticket Type | zoom_events_delete_ticket_type | Delete a ticket type from a Zoom Event. | |
| Duplicate Event | zoom_events_duplicate_event | Duplicate an existing Zoom Event (host action). | |
| Event Action | zoom_events_event_action | Run a lifecycle action on an event (publish, duplicate, cancel, etc.). | |
| Get Access Link | zoom_events_get_access_link | Retrieve a single event access link. | |
| Get Attendance Report | zoom_events_get_attendance_report | Get the event attendance (live or lobby) report. | |
| Get Attendee Engagement | zoom_events_get_attendee_engagement | Get attendee engagement analytics data for an event. | |
| Get Chat Transcript Report | zoom_events_get_chat_transcript_report | Get the chat transcript report for an event session. | |
| Get Custom Report | zoom_events_get_custom_report | Get a custom-defined report for an event. | |
| Get Event | zoom_events_get_event | Retrieve a single Zoom Events event. | |
| Get Exhibitor | zoom_events_get_exhibitor | Retrieve a single exhibitor. | |
| Get Registrations Report | zoom_events_get_registrations_report | Get the event registrations report. | |
| Get Session | zoom_events_get_session | Get details of a session in a Zoom Event. | |
| Get Session Attendance Report | zoom_events_get_session_attendance_report | Get the attendance report for a specific session. | |
| Get Session Join Token | zoom_events_get_session_join_token | Get a ticket’s session join token by event ID and session ID. | |
| Get Session Livestream | zoom_events_get_session_livestream | Get the livestream configuration for a session. | |
| Get Session Recording | zoom_events_get_session_recording | Get the cloud recording for a specific event session. | |
| Get Session Report | zoom_events_get_session_report | Get the sessions report for an event. | |
| Get Speaker | zoom_events_get_speaker | Get a single speaker. | |
| Get Survey Report | zoom_events_get_survey_report | Get the event survey report. | |
| Get Ticket | zoom_events_get_ticket | Get a single ticket’s details. | |
| List Access Links | zoom_events_list_access_links | List an event’s access links. | |
| List Attendee Actions | zoom_events_list_attendee_actions | List event-level attendee actions (e.g. check-in status). | |
| List Co-Editors | zoom_events_list_coeditors | List the co-editors of an event. | |
| List Email Send Status | zoom_events_list_email_send_status | List the send status of a given event email type. | |
| List Email Types | zoom_events_list_email_types | List the email types configured for an event. | |
| List Event Attendee Actions | zoom_events_list_event_attendee_actions | List event-level attendee actions (invitations / status). | |
| List Event Registration Questions | zoom_events_list_event_questions | List registration questions for a Zoom Event. | |
| List Events | zoom_events_list_events | List Zoom Events events, optionally scoped to a hub. | |
| List Exhibitors | zoom_events_list_exhibitors | List exhibitors/sponsors of an event. | |
| List Hub Hosts | zoom_events_list_hub_hosts | List the hosts belonging to a Zoom Events hub. | |
| List Hub Videos | zoom_events_list_hub_videos | List the videos and recording sessions stored on a Zoom Events hub. | |
| List Hubs | zoom_events_list_hubs | List the Zoom Events hubs the account can access. | |
| List Registrants | zoom_events_list_registrants | List registrants for a Zoom Event. | |
| List Session Attendee Actions | zoom_events_list_session_attendee_actions | List session-level attendee actions. | |
| List Session Attendees | zoom_events_list_session_attendees | List attendees of a specific Zoom Event session. | |
| List Session Interpreters | zoom_events_list_session_interpreters | List the interpreters for a session. | |
| List Session Polls | zoom_events_list_session_polls | List the polls for a session. | |
| List Session Recordings | zoom_events_list_session_recordings | List the cloud recordings for an event’s sessions. | |
| List Session Reservations | zoom_events_list_session_reservations | List the reservations for a session. | |
| List Sessions | zoom_events_list_sessions | List the sessions in a Zoom Event. | |
| List Speakers | zoom_events_list_speakers | List speakers for a Zoom Event. | |
| List Sponsor Tiers | zoom_events_list_sponsor_tiers | List sponsor tiers for a Zoom Event. | |
| List Ticket Type Questions | zoom_events_list_ticket_type_questions | List registration questions for a specific ticket type. | |
| List Ticket Types | zoom_events_list_ticket_types | List the ticket types configured for an event. | |
| List Tickets | zoom_events_list_tickets | List tickets (registrations) for a Zoom Event. | |
| Publish Event | zoom_events_publish_event | Publish a Zoom Event (host action). | |
| Remove Hub Host | zoom_events_remove_hub_host | Remove a host from a Zoom Events hub. | |
| Update Access Link | zoom_events_update_access_link | Update an event access link. | |
| Update Attendee Actions | zoom_events_update_attendee_actions | Update event-level attendee actions (e.g. check attendees in). | |
| Update Co-Editors | zoom_events_update_coeditors | Add or remove co-editors on an event. | |
| Update Event | zoom_events_update_event | Update a Zoom Events event. | |
| Update Event Attendee Actions | zoom_events_update_event_attendee_actions | Perform event-level attendee actions (invite, approve, deny, etc.). | |
| Update Event Registration Questions | zoom_events_update_event_questions | Update registration questions for a Zoom Event. | |
| Update Exhibitor | zoom_events_update_exhibitor | Update an exhibitor. | |
| Update Session | zoom_events_update_session | Update a session in a Zoom Event. | |
| Update Session Attendee Actions | zoom_events_update_session_attendee_actions | Update session-level attendee actions. | |
| Update Session Interpreters | zoom_events_update_session_interpreters | Set/replace the interpreters for a session. | |
| Update Session Livestream | zoom_events_update_session_livestream | Update the livestream configuration for a session. | |
| Update Session Polls | zoom_events_update_session_polls | Set/replace the polls for a session. | |
| Update Speaker | zoom_events_update_speaker | Update a speaker for a Zoom Event. | |
| Update Ticket | zoom_events_update_ticket | Update a ticket for a Zoom Event. | |
| Update Ticket Type | zoom_events_update_ticket_type | Update a ticket type for a Zoom Event. | |
| Update Ticket Type Questions | zoom_events_update_ticket_type_questions | Update registration questions for a specific ticket type. |
Zoom mail
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Batch Delete Messages | mail_batch_delete_messages | Permanently delete multiple Zoom Mail messages at once. | |
| Batch Modify Messages | mail_batch_modify_messages | Modify labels on multiple Zoom Mail messages at once. | |
| Create Draft | mail_create_draft | Create a new draft email in a Zoom Mail mailbox. | |
| Delete Draft | mail_delete_draft | Permanently delete a draft email from a Zoom Mail mailbox. | |
| Delete Message | mail_delete_message | Permanently delete a specific Zoom Mail message. | |
| Delete Thread | mail_delete_thread | Permanently delete a Zoom Mail thread and all its messages. | |
| Get Attachment | mail_get_attachment | Retrieve a message attachment from a Zoom Mail mailbox. | |
| Get Draft | mail_get_draft | Retrieve a specific draft email from a Zoom Mail mailbox. | |
| Get Message | mail_get_message | Retrieve a specific message from a Zoom Mail mailbox. | |
| Get Thread | mail_get_thread | Retrieve a specific email thread from a Zoom Mail mailbox. | |
| Insert Message | mail_insert_message | Directly insert a message into a Zoom Mail mailbox (does not send). | |
| List Drafts | mail_list_drafts | List the draft messages in a Zoom Mail mailbox. | |
| List Messages | mail_list_messages | List the messages in a Zoom Mail mailbox. | |
| List Threads | mail_list_threads | List the email threads in a Zoom Mail mailbox. | |
| Mail: Create Label | mail_create_label | Create a new label in a Zoom Mail mailbox. | |
| Mail: Delete Label | mail_delete_label | Delete a label from a Zoom Mail mailbox. | |
| Mail: Get Label | mail_get_label | Retrieve a specific label from a Zoom Mail mailbox. | |
| Mail: Get Mailbox Profile | mail_get_mailbox_profile | Get the profile of a Zoom Mail mailbox. | |
| Mail: List Labels | mail_list_labels | List all labels in a Zoom Mail mailbox. | |
| Mail: List Mailbox History | mail_list_history | List the history of changes to a Zoom Mail mailbox. | |
| Mail: Patch Label | mail_patch_label | Patch a label in a Zoom Mail mailbox (partial update). | |
| Mail: Update Label | mail_update_label | Update (replace) a label in a Zoom Mail mailbox. | |
| Modify Message Labels | mail_modify_message | Add or remove labels on a specific Zoom Mail message. | |
| Modify Thread Labels | mail_modify_thread | Add or remove labels on all messages in a Zoom Mail thread. | |
| Send Draft | mail_send_draft | Send an existing draft email from a Zoom Mail mailbox. | |
| Send Message | mail_send_message | Send an email message to recipients from a Zoom Mail mailbox. | |
| Trash Message | mail_trash_message | Move a Zoom Mail message to the TRASH folder. | |
| Trash Thread | mail_trash_thread | Move a Zoom Mail thread to the TRASH folder. | |
| Untrash Message | mail_untrash_message | Move a Zoom Mail message out of the TRASH folder. | |
| Untrash Thread | mail_untrash_thread | Move a Zoom Mail thread out of the TRASH folder. | |
| Update Draft | mail_update_draft | Replace the content of an existing draft email. |
Zoom phone
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Activate Carrier Reseller Numbers | active_cr_phone_numbers | Activate carrier reseller phone numbers. | |
| Add Account Outbound Exception Rule | add_account_outbound_exception | Add an account-level outbound calling exception rule. | |
| Add Audio Item | add_audio_item | Add a text-to-speech audio item (prompt) to a user’s audio library. | |
| Add Audio Items (Batch) | add_audio_items_batch | Add multiple audio items (prompts) to a user’s audio library in one request. | |
| Add Auto Receptionist Call Handling | add_auto_receptionist_call_handling | Add a call handling setting (custom/holiday hours) to an auto receptionist. | |
| Add Auto Receptionist Setting | add_auto_receptionist_setting | Add a sub-setting (e.g. holiday hours) to an auto receptionist. | |
| Add BYOC Numbers | add_byoc_numbers | Add BYOC (Bring Your Own Carrier) phone numbers to an account. | |
| Add BYOC Phone Numbers | add_byoc_number | Add BYOC (Bring Your Own Carrier) phone numbers. | |
| Add Call Handling Setting | add_call_handling_setting | Add a call handling setting for a Zoom Phone extension. | |
| Add Call Queue Call Handling Setting | add_call_queue_call_handling | Add a call handling setting to a call queue (e.g. holiday, custom_hours). | |
| Add Call Queue Custom Group Members | add_call_queue_custom_group_members | Add members to a call queue custom group. | |
| Add Call Queue Managers | add_call_queue_managers | Add or assign a manager to a call queue. | |
| Add Call Queue Members | add_call_queue_members | Add members (users or common area phones) to a call queue. | |
| Add Call Queue Setting | add_call_queue_setting | Add a setting to a call queue (e.g. opt-out reasons). | |
| Add Client Code to Call History | add_call_history_client_code | Add or update a client code on a call history record. | |
| Add Client Code to Call Log | add_user_call_log_client_code | Add or update a client code on a specific user’s call log record (legacy Call Logs API). | |
| Add Common Area | add_common_area | Create (provision) a new common area phone. | |
| Add Common Area Outbound Calling Exception Rule | add_common_area_outbound_calling_exception_rule | Add a common area’s outbound calling exception rule. | |
| Add Common Area Outbound Exception Rule | add_common_area_outbound_exception | Add a common-area-level outbound calling exception rule. | |
| Add Common Area Setting | add_common_area_setting | Add a setting (e.g. desk phone, outbound caller id) to a common area. | |
| Add Dial-by-Name Directory Users | add_dial_by_name_directory_users | Add users (extensions) to the account-level dial-by-name directory of a site. | |
| Add Emergency Address | add_emergency_address | Add a new emergency address to the Zoom Phone account. | |
| Add Emergency Service Location | add_emergency_service_location | Add a new emergency service (nomadic) location. | |
| Add Extension Inbound Block Rule | add_extension_inbound_block_rule | Add an extension-level inbound blocked rule. | |
| Add External Contact | add_external_contact | Add an external contact. | |
| Add Firmware Update Rule | add_firmware_update_rule | Add a firmware update rule to keep devices on a specific firmware version. | |
| Add Group Call Pickup Members | add_group_call_pickup_members | Add members to a group call pickup object. | |
| Add Inbound Block Rule | add_inbound_block_rule | Add an account-level inbound blocked rule. | |
| Add Monitoring Group Members | add_monitoring_group_members | Add monitors or monitored members to a Zoom Phone monitoring group. | |
| Add Number To Blocked List | add_blocked_list_number | Add a phone number or prefix to the account blocked list. | |
| Add Peering Numbers | add_peering_numbers | Add peering phone numbers. | |
| Add Phone Alert Setting | add_phone_alert_setting | Add a Zoom Phone alert setting. | |
| Add Phone Device | add_phone_device | Add a desk phone/device to a Zoom Phone account. | |
| Add Phone Role Members | add_phone_role_members | Add members (users) to a Zoom Phone role. | |
| Add Phone Site Setting | add_phone_site_setting | Add a setting (e.g. outbound caller ID customized numbers) to a Zoom Phone site. | |
| Add Phone User Setting | add_phone_user_setting | Add a specific Zoom Phone user setting (e.g. delegation, shared access). | |
| Add Phone Zoom Room | add_phone_zoom_room | Add a Zoom Room to Zoom Phone (assign a Zoom Phone license). | |
| Add Private Directory Members | add_private_directory_members | Add members to the Zoom Phone private directory. | |
| Add Provision Template | add_provision_template | Add a provision template. | |
| Add Routing Rule | add_routing_rule | Add a directory backup routing rule. | |
| Add Shared Line Group Members | add_slg_members | Add members (users/common areas) to a shared line group. | |
| Add Shared Line Group Outbound Caller IDs | add_slg_outbound_caller_ids | Add customized outbound caller ID phone numbers to a shared line group. | |
| Add Shared Line Group Policy | add_slg_policy | Add a policy sub-setting to a shared line group. | |
| Add Site Dial-by-Name Directory Users | add_site_dial_by_name_directory_users | Add users (extensions) to the dial-by-name directory of a specific site. | |
| Add Site Outbound Caller IDs | add_site_outbound_caller_ids | Add customized outbound caller ID phone numbers to a Zoom Phone site. | |
| Add Site Outbound Exception Rule | add_site_outbound_exception | Add a site-level outbound calling exception rule. | |
| Add User Customized Caller ID | add_phone_user_customized_caller_id | Add customized outbound caller ID numbers for a Zoom Phone user. | |
| Add User Outbound Exception Rule | add_user_outbound_exception | Add a user-level outbound calling exception rule. | |
| Assign Call Queue Phone Numbers | assign_call_queue_phone_numbers | Assign phone numbers to a call queue. | |
| Assign Calling Plan To Phone Zoom Room | assign_calling_plan_to_phone_zoom_room | Assign calling plans to a Zoom Room. | |
| Assign Calling Plans | assign_phone_calling_plans | Assign calling plans to a Zoom Phone user. | |
| Assign Common Area Calling Plans | assign_common_area_calling_plans | Assign one or more calling plans to a common area. | |
| Assign Common Area Phone Numbers | assign_common_area_phone_numbers | Assign phone numbers to a common area. | |
| Assign Entity To Phone Device | assign_phone_entity_to_device | Assign an entity (extension) to a shared or common area Zoom Phone device. | |
| Assign Phone Number To Phone Zoom Room | assign_phone_number_to_phone_zoom_room | Assign phone numbers to a Zoom Room. | |
| Assign Phone Numbers | assign_auto_receptionist_phone_numbers | Assign phone numbers to an auto receptionist. | |
| Assign Phone Numbers | assign_phone_numbers_to_user | Assign phone numbers to a Zoom Phone user. | |
| Assign Shared Line Group Phone Numbers | assign_slg_phone_numbers | Assign phone numbers to a shared line group. | |
| Assign SMS Campaign Phone Numbers | assign_sms_campaign_phone_numbers | Assign one or more phone numbers to an SMS campaign. | |
| Batch Add Emergency Service Locations | batch_add_emergency_service_locations | Batch add multiple emergency service (nomadic) locations in one request. | |
| Batch Update Phone Users | batch_update_phone_users | Batch update multiple Zoom Phone users. | |
| Create Auto Receptionist | create_auto_receptionist | Add a new auto receptionist to a Zoom Phone site. | |
| Create Call Queue | create_call_queue | Create a new call queue. | |
| Create Call Queue Custom Group | create_call_queue_custom_group | Create a custom group in a call queue. | |
| Create Carrier Reseller Numbers | create_cr_phone_numbers | Create carrier reseller phone numbers. | |
| Create Fax Document | create_fax_document | Create a Zoom Phone fax document from previously uploaded file(s). | |
| Create Group Call Pickup Object | create_group_call_pickup | Create a group call pickup object. | |
| Create Monitoring Group | create_monitoring_group | Create a Zoom Phone monitoring group. | |
| Create Phone Setting Template | create_phone_setting_template | Create a Zoom Phone setting template. | |
| Create Phone Site | create_phone_site | Create a Zoom Phone site. | |
| Create Shared Line Group | create_shared_line_group | Create a shared line group. | |
| Delete Account Outbound Exception Rule | delete_account_outbound_exception | Delete an account-level outbound calling exception rule. | |
| Delete Audio Item | delete_audio_item | Delete an audio item (prompt) from the audio library. | |
| Delete Auto Receptionist | delete_auto_receptionist | Delete a non-primary auto receptionist. | |
| Delete Auto Receptionist Call Handling | delete_auto_receptionist_call_handling | Delete a call handling setting (custom/holiday hours) of an auto receptionist. | |
| Delete Auto Receptionist Setting | delete_auto_receptionist_setting | Delete a sub-setting (e.g. a holiday) of an auto receptionist. | |
| Delete Blocked List Entry | delete_blocked_list | Delete a blocked-list entry. | |
| Delete Call Handling Setting | delete_call_handling_setting | Delete a call handling setting for a Zoom Phone extension. | |
| Delete Call History | delete_call_history | Delete a single call history record for the account. | |
| Delete Call Queue | delete_call_queue | Delete a call queue. | |
| Delete Call Queue Call Handling Setting | delete_call_queue_call_handling | Delete a call handling setting from a call queue (e.g. remove holiday/custom hours). | |
| Delete Call Queue Custom Group | delete_call_queue_custom_group | Delete a custom group from a call queue. | |
| Delete Call Queue Setting | delete_call_queue_setting | Delete a setting from a call queue (e.g. opt-out reasons). | |
| Delete Carrier Reseller Number | delete_cr_phone_number | Delete a carrier reseller phone number. | |
| Delete Common Area | delete_common_area | Delete a common area. | |
| Delete Common Area Outbound Calling Exception Rule | delete_common_area_outbound_calling_exception_rule | Delete a common area’s outbound calling exception rule. | |
| Delete Common Area Outbound Exception Rule | delete_common_area_outbound_exception | Delete a common-area-level outbound calling exception rule. | |
| Delete Common Area Setting | delete_common_area_setting | Delete a setting of a common area. | |
| Delete Dial-by-Name Directory Users | delete_dial_by_name_directory_users | Delete users (extensions) from the account-level dial-by-name directory of a site. | |
| Delete Emergency Address | delete_emergency_address | Delete a specific emergency address by ID. | |
| Delete Emergency Service Location | delete_emergency_service_location | Delete a specific emergency service location by ID. | |
| Delete Extension Inbound Block Rule | delete_extension_inbound_block_rule | Delete an extension-level inbound blocked rule. | |
| Delete External Contact | delete_external_contact | Delete an external contact. | |
| Delete Firmware Update Rule | delete_firmware_update_rule | Delete a firmware update rule. | |
| Delete Group Call Pickup Object | delete_group_call_pickup | Delete a group call pickup object. | |
| Delete Inbound Block Rule | delete_inbound_block_rule | Delete an account-level inbound blocked rule. | |
| Delete Inbound Block Statistic | delete_inbound_block_statistic | Delete an account-level inbound blocked statistic. | |
| Delete Monitoring Group | delete_monitoring_group | Delete a Zoom Phone monitoring group. | |
| Delete Peering Numbers | delete_peering_numbers | Remove peering phone numbers. | |
| Delete Phone Alert Setting | delete_phone_alert_setting | Delete a Zoom Phone alert setting. | |
| Delete Phone Device | delete_phone_device | Remove a desk phone/device from the Zoom Phone account. | |
| Delete Phone Recording | delete_phone_recording | Delete a Zoom Phone call recording by recording ID. | |
| Delete Phone Role | delete_phone_role | Delete a Zoom Phone role. | |
| Delete Phone Role Members | delete_phone_role_members | Remove members from a Zoom Phone role. | |
| Delete Phone Site | delete_phone_site | Delete a Zoom Phone site, transferring its assets to another site. | |
| Delete Phone Site Setting | delete_phone_site_setting | Delete a specific setting from a Zoom Phone site. | |
| Delete Phone User Setting | delete_phone_user_setting | Delete a specific Zoom Phone user setting. | |
| Delete Private Directory Member | delete_private_directory_member | Remove a member from the Zoom Phone private directory. | |
| Delete Provision Template | delete_provision_template | Delete a provision template. | |
| Delete Routing Rule | delete_routing_rule | Delete a directory backup routing rule. | |
| Delete Shared Line Group | delete_shared_line_group | Delete a shared line group. | |
| Delete Site Dial-by-Name Directory Users | delete_site_dial_by_name_directory_users | Delete users (extensions) from the dial-by-name directory of a specific site. | |
| Delete Site Outbound Caller IDs | delete_site_outbound_caller_ids | Remove customized outbound caller ID phone numbers from a Zoom Phone site. | |
| Delete Site Outbound Exception Rule | delete_site_outbound_exception | Delete a site-level outbound calling exception rule. | |
| Delete User Call History | delete_user_call_history | Delete a single call history record for a specific user. | |
| Delete User Call Log | delete_phone_user_call_log | Delete a specific call log for a Zoom Phone user. | |
| Delete User Call Log | delete_user_call_log | Delete a single call log record for a specific user (legacy Call Logs API). | |
| Delete User Customized Caller ID | delete_phone_user_customized_caller_id | Delete customized outbound caller ID numbers from a Zoom Phone user. | |
| Delete User Data | delete_phone_user_data | Delete a Zoom Phone user’s call logs, recordings, and voicemails. | |
| Delete User Outbound Exception Rule | delete_user_outbound_exception | Delete a user-level outbound calling exception rule. | |
| Delete User Voicemail | delete_phone_user_voicemail | Delete a specific voicemail for a Zoom Phone user. | |
| Delete Voicemail | delete_voicemail | Delete a voicemail from the Zoom Phone account. | |
| Download Phone Recording Transcript | download_phone_recording_transcript | Download the transcript of a Zoom Phone recording. | |
| Duplicate Phone Role | duplicate_phone_role | Duplicate an existing Zoom Phone role to create a new one. | |
| Get Account Call History | get_account_call_history | Get the account’s call history (Call History API, replaces legacy call logs). | |
| Get Account Outbound Calling Countries | get_account_outbound_calling | Get the account-level outbound calling countries/regions. | |
| Get Audio Item | get_audio_item | Get details of an audio item (prompt) by its ID. | |
| Get Auto Receptionist | get_auto_receptionist | Get details of a specific auto receptionist. | |
| Get Auto Receptionist Call Handling | get_auto_receptionist_call_handling | Get the call handling settings (business/closed/holiday hours) of an auto receptionist. | |
| Get Auto Receptionist IVR | get_auto_receptionist_ivr | Get the IVR (interactive voice response) configuration for an auto receptionist. | |
| Get Auto Receptionist Policy | get_auto_receptionist_policy | Get the policy settings for an auto receptionist. | |
| Get Auto Receptionist Settings | get_auto_receptionist_settings | Get the settings of an auto receptionist. | |
| Get Blocked List Entry | get_blocked_list | Get the details of a single blocked-list entry. | |
| Get Call Handling Settings | get_call_handling_settings | Get an extension’s Zoom Phone call handling settings. | |
| Get Call History Detail | get_call_history_detail | Get the call path (detailed history) of a single call history record. | |
| Get Call Log Detail | get_call_log_detail | Get the details of a single account call log (legacy Call Logs API). | |
| Get Call Log Metrics Details | get_call_log_metrics_details | Get the metrics details of a single Zoom Phone call log. | |
| Get Call QoS | get_call_qos | Get the Quality of Service (QoS) details for a Zoom Phone call. | |
| Get Call Queue | get_call_queue | Get details of a specific call queue. | |
| Get Call Queue Call Handling | get_call_queue_call_handling | Get the call handling settings of a call queue (business/closed/holiday hours, routing). | |
| Get Call Queue Custom Group | get_call_queue_custom_group | Get a specific custom group of a call queue. | |
| Get Call Queue Manual Outbound Caller ID | get_call_queue_manual_outbound_caller_id | List the phone numbers that can be set as the manual outbound caller ID of a call queue. | |
| Get Call Queue Policy | get_call_queue_policy | Get a call queue’s policy (all sub-settings). | |
| Get Call Queue Recordings | get_call_queue_recordings | Get the recordings of a call queue. | |
| Get Call Queue Settings | get_call_queue_settings | Get the settings of a call queue. | |
| Get Common Area | get_common_area | Get details of a specific common area. | |
| Get Common Area Outbound Calling Countries | get_common_area_outbound_calling | Get a common area’s outbound calling countries/regions. | |
| Get Common Area Outbound Calling Countries/Regions | get_common_area_outbound_calling_countries_regions | List a common area’s outbound calling countries and regions. | |
| Get Common Area Settings | get_common_area_settings | Get the settings of a common area. | |
| Get Emergency Address | get_emergency_address | Get the details of a specific emergency address by ID. | |
| Get Emergency Service Location | get_emergency_service_location | Get the details of a specific emergency service location by ID. | |
| Get External Contact | get_external_contact | Get external contact details. | |
| Get Fax Log | get_fax_log | Get the details of a single Zoom Phone fax log. | |
| Get Fax Log File | get_fax_log_file | Get (download link for) a file attached to a Zoom Phone fax log. | |
| Get Firmware Update Rule | get_firmware_update_rule | Get details of a firmware update rule. | |
| Get Group Call Pickup Object | get_group_call_pickup | Get details of a group call pickup object. | |
| Get Monitoring Group | get_monitoring_group | Get details of a specific Zoom Phone monitoring group. | |
| Get Phone Account Settings | get_phone_account_settings | Get an account’s Zoom Phone settings. | |
| Get Phone Alert Setting | get_phone_alert_setting | Get details of a Zoom Phone alert setting. | |
| Get Phone Billing Account | get_phone_billing_account | Get details of a specific Zoom Phone billing account. | |
| Get Phone BYOC Settings | get_phone_byoc_settings | Get an account’s BYOC (Bring Your Own Carrier) settings. | |
| Get Phone Call Recordings | get_phone_call_recordings | Get the recordings of a Zoom Phone call by its call log ID. | |
| Get Phone Device | get_phone_device | Get information about a specific Zoom Phone device. | |
| Get Phone Device Line Keys | get_phone_device_line_keys | Get the line key position and configuration for a Zoom Phone device. | |
| Get Phone Extension Line Keys | get_phone_user_line_keys | Get the line key position and settings of a Zoom Phone extension. | |
| Get Phone Group | get_phone_group | Get details of a Zoom Phone group. | |
| Get Phone Number Details | get_phone_number_details | Get details about a specific Zoom Phone number. | |
| Get Phone Operation Logs Report | get_phone_operation_logs_report | Get the Zoom Phone operation logs report. | |
| Get Phone Recording | get_phone_recording | Get a Zoom Phone recording by its recording ID. | |
| Get Phone Recording Detail | get_phone_recording_detail | Get detailed information of a Zoom Phone recording by recording ID. | |
| Get Phone Role | get_phone_role | Get information about a specific Zoom Phone role. | |
| Get Phone Setting Template | get_phone_setting_template | Get details of a Zoom Phone setting template. | |
| Get Phone SIP Trunk Settings | get_phone_sip_trunk_settings | Get an account’s SIP trunk (SIP account) settings. | |
| Get Phone Site | get_phone_site | Get details of a specific Zoom Phone site. | |
| Get Phone Site Setting | get_phone_site_setting | Get a specific setting type for a Zoom Phone site. | |
| Get Phone User | get_phone_user | Get a Zoom Phone user’s profile. | |
| Get Phone User Settings | get_phone_user_settings | Get a Zoom Phone user’s settings. | |
| Get Phone Zoom Room | get_phone_zoom_room | Get a Zoom Room under a Zoom Phone license. | |
| Get Port Order Details | get_port_order_details | Get the details of a specific port order (ported numbers). | |
| Get Provision Template | get_provision_template | Get a provision template. | |
| Get Routing Rule | get_routing_rule | Get a directory backup routing rule. | |
| Get Shared Line Group | get_shared_line_group | Get details of a shared line group. | |
| Get Shared Line Group Policies | get_slg_policies | Get all policies of a shared line group. | |
| Get Shared Line Group Policy | get_slg_policy | Get a specific policy sub-setting of a shared line group. | |
| Get Site Outbound Calling Countries | get_site_outbound_calling | Get a site’s outbound calling countries/regions. | |
| Get SMS By Message ID | get_sms_by_message_id | Get a single SMS/MMS message by its message ID within a session. | |
| Get SMS Campaign | get_sms_campaign | Get the details of a specific SMS campaign. | |
| Get SMS Session Details | get_sms_session_details | Get the message-level details of an SMS session. | |
| Get User Call History | get_phone_user_call_history | Get a Zoom Phone user’s call history. | |
| Get User Call History | get_user_call_history | Get a specific user’s call history (Call History API). | |
| Get User Call Logs | get_phone_user_call_logs | Get a Zoom Phone user’s call logs. | |
| Get User Call Logs | get_user_call_logs | Get a specific user’s call logs (legacy Call Logs API). | |
| Get User Outbound Calling Countries | get_user_outbound_calling | Get a user’s outbound calling countries/regions. | |
| Get User Profile Setting | get_phone_user_profile_settings | Get a Zoom Phone user’s profile settings (business/closed/holiday hours). | |
| Get User Recordings | get_phone_user_recordings | Get a Zoom Phone user’s call recordings. | |
| Get User Voicemails | get_phone_user_voicemails | Get a Zoom Phone user’s voicemails. | |
| Get Voicemail | get_voicemail | Get a voicemail’s details, including its download URL and transcription. | |
| List Account Outbound Exception Rules | list_account_outbound_exceptions | List account-level outbound calling exception rules. | |
| List Account Voicemails | list_account_voicemails | List all voicemails across the Zoom Phone account. | |
| List Audio Items | list_audio_items | List audio items (prompts) in a user’s Zoom Phone audio library. | |
| List Auto Receptionists | list_auto_receptionists | List all auto receptionists on the Zoom Phone account. | |
| List Available Phone Numbers | list_available_phone_numbers | List phone numbers that are available (unassigned) in an account. | |
| List Blocked List | list_blocked_list | List the account’s Zoom Phone blocked-list entries. | |
| List BYOC SIP Trunks | list_byoc_sip_trunks | List BYOC SIP trunks. | |
| List Call Logs Metrics | list_call_logs_metrics | List Zoom Phone call logs metrics (QoS overview) for the account. | |
| List Call Queue Custom Groups | list_call_queue_custom_groups | List the custom groups of a call queue. | |
| List Call Queue Members | list_call_queue_members | List the members of a call queue. | |
| List Call Queues | list_call_queues | List all call queues in a Zoom Phone account. | |
| List Carrier Peering Numbers | list_carrier_peering_numbers | List carrier peering phone numbers. | |
| List Carrier Reseller Numbers | list_cr_phone_numbers | List carrier reseller phone numbers. | |
| List Common Area Activation Codes | list_common_area_activation_codes | List activation codes of common areas. | |
| List Common Area Outbound Calling Exception Rules | list_common_area_outbound_calling_exception_rules | List a common area’s outbound calling exception rules. | |
| List Common Area Outbound Exception Rules | list_common_area_outbound_exceptions | List a common area’s outbound calling exception rules. | |
| List Common Areas | list_common_areas | List all common areas in a Zoom Phone account. | |
| List Dial-by-Name Directory Users | list_dial_by_name_directory_users | List users (extensions) in the account-level dial-by-name directory for a site. | |
| List Emergency Addresses | list_emergency_addresses | List all emergency addresses for the Zoom Phone account. | |
| List Emergency Service Locations | list_emergency_service_locations | List all emergency service (nomadic) locations for the Zoom Phone account. | |
| List Extension Fax Logs | list_extension_fax_logs | List Zoom Phone fax logs for a specific extension. | |
| List Extension Inbound Block Rules | list_extension_inbound_block_rules | List extension-level inbound blocked rules. | |
| List External Contacts | list_external_contacts | List external contacts. | |
| List Fax Logs | list_fax_logs | List Zoom Phone fax logs across the account. | |
| List Firmware Update Rules | list_firmware_update_rules | List firmware update rules configured for the account or a site. | |
| List Group Call Pickup Members | list_group_call_pickup_members | List members of a group call pickup object. | |
| List Group Call Pickup Objects | list_group_call_pickup | List all group call pickup objects for the account. | |
| List Inbound Block Rules | list_inbound_block_rules | List account-level inbound blocked rules. | |
| List Inbound Block Statistics | list_inbound_block_statistics | List account-level inbound blocked statistics (numbers blocked by extensions). | |
| List Location Tracking | list_location_tracking | List Zoom Phone location tracking (network location) records. | |
| List Monitoring Group Members | list_monitoring_group_members | List the monitors or monitored members of a Zoom Phone monitoring group. | |
| List Monitoring Groups | list_monitoring_groups | List all monitoring groups on a Zoom Phone account. | |
| List Past Calls | list_past_calls | List Zoom Phone past calls of a phone number. | |
| List Peering Numbers | list_peering_numbers | List peering phone numbers. | |
| List Phone Alert Settings | list_phone_alert_settings | List Zoom Phone alert settings for the account. | |
| List Phone Billing Accounts | list_phone_billing_accounts | List Zoom Phone billing accounts. | |
| List Phone Device Firmwares | list_phone_device_firmwares | List the firmware update rules configured for a Zoom Phone device. | |
| List Phone Devices | list_phone_devices | List all the desk phone devices configured for Zoom Phone in the account. | |
| List Phone Groups | list_phone_groups | List Zoom Phone groups. | |
| List Phone Numbers | list_phone_numbers | List all Zoom Phone numbers in an account. | |
| List Phone Plans | list_phone_plans | List the Zoom Phone plan information for the account. | |
| List Phone Recordings | list_phone_recordings | List all Zoom Phone call recordings for the account. | |
| List Phone Role Members | list_phone_role_members | List the members assigned to a Zoom Phone role. | |
| List Phone Roles | list_phone_roles | List all Zoom Phone roles on the account. | |
| List Phone Setting Templates | list_phone_setting_templates | List setting templates for an account or a Zoom Phone site. | |
| List Phone SIP Groups | list_phone_sip_groups | List an account’s Zoom Phone SIP groups. | |
| List Phone SIP Trunks | list_phone_sip_trunks | List the SIP trunks assigned to an account. | |
| List Phone Sites | list_phone_sites | List all Zoom Phone sites in the account. | |
| List Phone User Recordings | list_phone_user_recordings | List call recordings for a specific Zoom Phone user. | |
| List Phone Users | list_phone_users | List all of an account’s Zoom Phone users. | |
| List Phone Zoom Rooms | list_phone_zoom_rooms | List Zoom Rooms under a Zoom Phone license. | |
| List Ported Numbers | list_ported_numbers | List the port orders (ported numbers) in an account. | |
| List Private Directory Members | list_private_directory_members | List members of the Zoom Phone private directory. | |
| List Provision Templates | list_provision_templates | List provision templates. | |
| List Routing Rules | list_routing_rules | List directory backup routing rules. | |
| List Shared Line Group Members | list_slg_members | List members of a shared line group. | |
| List Shared Line Group Outbound Caller IDs | list_slg_outbound_caller_ids | List customized outbound caller ID phone numbers of a shared line group. | |
| List Shared Line Groups | list_shared_line_groups | List all shared line groups on the account. | |
| List Site Dial-by-Name Directory Users | list_site_dial_by_name_directory_users | List users (extensions) in the dial-by-name directory of a specific site. | |
| List Site Outbound Caller IDs | list_site_outbound_caller_ids | List the customized outbound caller ID phone numbers for a Zoom Phone site. | |
| List Site Outbound Exception Rules | list_site_outbound_exceptions | List a site’s outbound calling exception rules. | |
| List SMS Campaign Opt Status | list_sms_campaign_opt_status | List the opt-in/opt-out status of members for an SMS campaign phone number. | |
| List SMS Campaigns | list_sms_campaigns | List the SMS campaigns for the account. | |
| List SMS Sessions | list_sms_sessions | List an account’s SMS sessions within a date range. | |
| List Tracked Devices | list_tracked_devices | List Zoom Phone tracked devices used for the account’s metrics dashboard. | |
| List Unassigned Phone Numbers | list_unassigned_phone_numbers | List phone numbers that are not assigned to any extension. | |
| List Unassigned Phone Zoom Rooms | list_unassigned_phone_zoom_rooms | List Zoom Rooms without a Zoom Phone assignment. | |
| List Updatable Firmwares | list_updatable_firmwares | List firmware versions available for update on provisioned devices. | |
| List User Customized Caller ID | list_phone_user_customized_caller_id | List a Zoom Phone user’s customized outbound caller ID numbers. | |
| List User Outbound Exception Rules | list_user_outbound_exceptions | List a user’s outbound calling exception rules. | |
| List User SMS Sessions | list_user_sms_sessions | List a specific user’s SMS sessions within a date range. | |
| List User Voicemails | list_user_voicemails | List voicemails belonging to a specific Zoom Phone user. | |
| Mark Number Blocked For All | mark_number_blocked_for_all | Mark a phone number as blocked for all extensions. | |
| Opt SMS Campaign Members | opt_sms_campaign_members | Opt members (external phone numbers) in or out of an SMS campaign. | |
| Reboot Phone Device | reboot_phone_device | Reboot a desk phone that is assigned to a Zoom Phone user. | |
| Remove All Call Queue Members | remove_all_call_queue_members | Remove all members from a call queue. | |
| Remove All Monitoring Group Members | remove_monitoring_group_members | Remove all monitors or monitored members from a Zoom Phone monitoring group. | |
| Remove All Shared Line Group Members | remove_all_slg_members | Remove all members from a shared line group. | |
| Remove Call Queue Custom Group Member | remove_call_queue_custom_group_member | Remove a member from a call queue custom group. | |
| Remove Call Queue Manager | remove_call_queue_manager | Remove a manager from a call queue. | |
| Remove Call Queue Member | remove_call_queue_member | Remove a single member from a call queue. | |
| Remove Group Call Pickup Member | remove_group_call_pickup_member | Remove a member from a group call pickup object. | |
| Remove Monitoring Group Member | remove_monitoring_group_member | Remove a single member (by extension ID) from a Zoom Phone monitoring group. | |
| Remove Phone Zoom Room | remove_phone_zoom_room | Remove a Zoom Room from a Zoom Phone account. | |
| Remove Shared Line Group Member | remove_slg_member | Remove a single member from a shared line group. | |
| Remove Shared Line Group Outbound Caller IDs | remove_slg_outbound_caller_ids | Remove customized outbound caller ID phone numbers from a shared line group. | |
| Remove Shared Line Group Policy | remove_slg_policy | Remove a policy sub-setting from a shared line group. | |
| Sync Phone Devices | sync_phone_devices | Sync deskphones/devices under a Zoom Phone account. | |
| Sync Session SMS | sync_sms_by_session | Sync the messages of a specific SMS session (details sync view). | |
| Unassign All Call Queue Phone Numbers | unassign_all_call_queue_phone_numbers | Unassign all phone numbers from a call queue. | |
| Unassign All Phone Numbers | unassign_all_auto_receptionist_phone_numbers | Unassign all phone numbers from an auto receptionist. | |
| Unassign All Shared Line Group Phone Numbers | unassign_all_slg_phone_numbers | Unassign all phone numbers from a shared line group. | |
| Unassign Call Queue Phone Number | unassign_call_queue_phone_number | Unassign a specific phone number from a call queue. | |
| Unassign Calling Plan | unassign_phone_calling_plan | Unassign a calling plan from a Zoom Phone user. | |
| Unassign Calling Plan From Phone Zoom Room | unassign_calling_plan_from_phone_zoom_room | Remove a calling plan from a Zoom Room. | |
| Unassign Common Area Calling Plan | unassign_common_area_calling_plan | Unassign a calling plan from a common area by plan type. | |
| Unassign Common Area Phone Number | unassign_common_area_phone_number | Unassign a phone number from a common area. | |
| Unassign Entity From Phone Device | unassign_phone_entity_from_device | Unassign an entity (extension) from a shared or common area Zoom Phone device. | |
| Unassign Phone Number | unassign_auto_receptionist_phone_number | Unassign a specific phone number from an auto receptionist. | |
| Unassign Phone Number | unassign_phone_number_from_user | Unassign a phone number from a Zoom Phone user. | |
| Unassign Phone Number From Phone Zoom Room | unassign_phone_number_from_phone_zoom_room | Remove a phone number from a Zoom Room. | |
| Unassign Shared Line Group Phone Number | unassign_slg_phone_number | Unassign a single phone number from a shared line group. | |
| Unassign SMS Campaign Phone Number | unassign_sms_campaign_phone_number | Unassign a phone number from an SMS campaign. | |
| Update Account Outbound Calling Countries | update_account_outbound_calling | Update the account-level outbound calling countries/regions. | |
| Update Account Outbound Exception Rule | update_account_outbound_exception | Update an account-level outbound calling exception rule. | |
| Update Audio Item | update_audio_item | Update an audio item (prompt), e.g. rename it. | |
| Update Auto Receptionist | update_auto_receptionist | Update details of an auto receptionist. | |
| Update Auto Receptionist Call Handling | update_auto_receptionist_call_handling | Update a call handling setting (business/closed/holiday hours) of an auto receptionist. | |
| Update Auto Receptionist IVR | update_auto_receptionist_ivr | Update the IVR (interactive voice response) configuration for an auto receptionist. | |
| Update Auto Receptionist Policy | update_auto_receptionist_policy | Update the policy settings for an auto receptionist. | |
| Update Auto Receptionist Setting | update_auto_receptionist_setting | Update a sub-setting of an auto receptionist. | |
| Update Blocked List Entry | update_blocked_list | Update a blocked-list entry. | |
| Update BYOC Number | update_byoc_number | Update a BYOC (Bring Your Own Carrier) phone number’s information. | |
| Update Call Handling Setting | update_call_handling_setting | Update a call handling setting for a Zoom Phone extension. | |
| Update Call Queue | update_call_queue | Update the details of a call queue. | |
| Update Call Queue Call Handling Setting | update_call_queue_call_handling | Update a call handling setting of a call queue (business/closed/holiday hours, routing). | |
| Update Call Queue Manual Outbound Caller ID | update_call_queue_manual_outbound_caller_id | Update the manual outbound caller ID members / phone number of a call queue. | |
| Update Call Queue Policy | update_call_queue_policy | Update the policy sub-setting of a call queue (e.g. add/remove voicemail access members). | |
| Update Call Queue Recording Setting | update_call_queue_recording_setting | Update the recording settings of a call queue. | |
| Update Call Queue Setting | update_call_queue_setting | Update a setting of a call queue (e.g. opt-out reasons). | |
| Update Common Area | update_common_area | Update an existing common area. | |
| Update Common Area Outbound Calling Countries | update_common_area_outbound_calling | Update a common area’s outbound calling countries/regions. | |
| Update Common Area Outbound Calling Countries/Regions | update_common_area_outbound_calling_countries_regions | Update a common area’s outbound calling countries and regions. | |
| Update Common Area Outbound Calling Exception Rule | update_common_area_outbound_calling_exception_rule | Update a common area’s outbound calling exception rule. | |
| Update Common Area Outbound Exception Rule | update_common_area_outbound_exception | Update a common-area-level outbound calling exception rule. | |
| Update Common Area Setting | update_common_area_setting | Update a setting of a common area. | |
| Update Device Provision Template | update_device_provision_template | Update the provision template assigned to a device. | |
| Update Emergency Address | update_emergency_address | Update the details of a specific emergency address. | |
| Update Emergency Service Location | update_emergency_service_location | Update the details of a specific emergency service location. | |
| Update External Contact | update_external_contact | Update an external contact. | |
| Update Firmware Update Rule | update_firmware_update_rule | Update an existing firmware update rule. | |
| Update Group Call Pickup Object | update_group_call_pickup | Update a group call pickup object. | |
| Update Inbound Block Rule | update_inbound_block_rule | Update an account-level inbound blocked rule. | |
| Update Monitoring Group | update_monitoring_group | Update a Zoom Phone monitoring group. | |
| Update Peering Numbers | update_peering_numbers | Update peering phone numbers. | |
| Update Phone Account Settings | update_phone_account_settings | Update an account’s Zoom Phone settings for a specific setting type. | |
| Update Phone Alert Setting | update_phone_alert_setting | Update a Zoom Phone alert setting. | |
| Update Phone Device | update_phone_device | Update information about a Zoom Phone desk phone device. | |
| Update Phone Device Line Keys | update_phone_device_line_keys | Update the line key position and configuration for a Zoom Phone device. | |
| Update Phone Extension Line Keys | update_phone_user_line_keys | Update (batch) the line key settings of a Zoom Phone extension. | |
| Update Phone Number | update_phone_number | Update a phone number (e.g. assign it to a site). | |
| Update Phone Recording | update_phone_recording | Update the auto-delete field of a Zoom Phone recording. | |
| Update Phone Recording Status | update_phone_recording_status | Update (recover or delete) the status of a Zoom Phone recording. | |
| Update Phone Role | update_phone_role | Update a Zoom Phone role’s name, description, or privileges. | |
| Update Phone Setting Template | update_phone_setting_template | Update a Zoom Phone setting template. | |
| Update Phone SIP Trunk Settings | update_phone_sip_trunk_settings | Update an account’s SIP trunk (SIP account) settings. | |
| Update Phone Site | update_phone_site | Update details of a specific Zoom Phone site. | |
| Update Phone Site Setting | update_phone_site_setting | Update a specific setting type for a Zoom Phone site. | |
| Update Phone User | update_phone_user | Update a Zoom Phone user’s profile (extension, site, template, etc.). | |
| Update Phone User Setting | update_phone_user_setting | Update a specific Zoom Phone user setting. | |
| Update Phone User Settings | update_phone_user_settings | Update a Zoom Phone user’s settings. | |
| Update Phone Zoom Room | update_phone_zoom_room | Update a Zoom Room’s Zoom Phone settings (extension, policy, site). | |
| Update Private Directory Member | update_private_directory_member | Update a member in the Zoom Phone private directory. | |
| Update Provision Template | update_provision_template | Update a provision template. | |
| Update Routing Rule | update_routing_rule | Update a directory backup routing rule. | |
| Update Shared Line Group | update_shared_line_group | Update a shared line group’s basic settings. | |
| Update Shared Line Group Policies | update_slg_policies | Update policies of a shared line group. | |
| Update Shared Line Group Policy | update_slg_policy | Update a policy sub-setting of a shared line group. | |
| Update Site Outbound Calling Countries | update_site_outbound_calling | Update a site’s outbound calling countries/regions. | |
| Update Site Outbound Exception Rule | update_site_outbound_exception | Update a site-level outbound calling exception rule. | |
| Update Site’s Unassigned Numbers | update_site_unassigned_numbers | Update a site’s unassigned Zoom Phone numbers (up to 20 per request). | |
| Update User Customized Caller ID | update_phone_user_customized_caller_id | Update a Zoom Phone user’s customized outbound caller ID number. | |
| Update User Outbound Calling Countries | update_user_outbound_calling | Update a user’s outbound calling countries/regions. | |
| Update User Outbound Exception Rule | update_user_outbound_exception | Update a user-level outbound calling exception rule. | |
| Update Voicemail Read Status | update_voicemail_read_status | Mark a voicemail as read or unread. | |
| Upload Fax File | upload_fax_file | Upload a file to Zoom Phone fax storage for later sending. |
Zoom rooms
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Background Image Content | add_background_image_content | Add a background image to the Zoom Rooms content library. | |
| Add Content Folder | add_content_folder | Create a folder in the Zoom Rooms content library / digital signage. | |
| Assign Room Tags | assign_room_tags | Assign one or more tags to a Zoom Room. | |
| Change Zoom Room Location | change_zoom_room_location | Assign a Zoom Room to a different location (parent). | |
| Change Zoom Rooms Location Parent | change_rooms_location_parent | Change the parent location of a Zoom Rooms location. | |
| Control Zoom Room (Events) | control_zoom_room | Send a control command / meeting event to a Zoom Room (e.g. start/end/leave meeting, check-in, restart). | |
| Create Device Profile | create_device_profile | Create a Zoom Rooms device profile. | |
| Create Digital Signage Playlist | create_digital_signage_playlist | Create a Zoom Rooms digital signage playlist. | |
| Create Room Tag | create_room_tag | Create a new Zoom Rooms tag. | |
| Create Zoom Room | create_zoom_room | Add a new Zoom Room to an account. | |
| Create Zoom Rooms Location | create_rooms_location | Add a Zoom Rooms location. | |
| Delete Content Folder | delete_content_folder | Delete a Zoom Rooms content library / digital signage folder. | |
| Delete Content Library Item | delete_content_library_item | Delete a Zoom Rooms content library item. | |
| Delete Device Profile | delete_device_profile | Delete a Zoom Rooms device profile by its ID. | |
| Delete Digital Signage Playlist | delete_digital_signage_playlist | Delete a Zoom Rooms digital signage playlist. | |
| Delete Room Tag | delete_room_tag | Delete a Zoom Rooms tag by its ID. | |
| Delete Zoom Room | delete_zoom_room | Delete a specific Zoom Room from the account. | |
| Delete Zoom Room Device | delete_zoom_room_device | Remove/delete a device from a Zoom Room. | |
| Delete Zoom Rooms Location | delete_rooms_location | Delete a Zoom Rooms location. | |
| Get Device Profile | get_device_profile | Retrieve a single Zoom Rooms device profile by its ID. | |
| Get Digital Signage Playlist | get_digital_signage_playlist | Get a Zoom Rooms digital signage playlist’s details. | |
| Get Room Tag | get_room_tag | Retrieve a single Zoom Rooms tag by its ID. | |
| Get Zoom Room Profile | get_zoom_room_profile | Get detailed profile information for a specific Zoom Room. | |
| Get Zoom Room Sensor Data | get_zoom_room_sensor_data | Get sensor data (people count, temperature, humidity, etc.) reported by a Zoom Room. | |
| Get Zoom Room Settings | get_zoom_room_settings | Get the meeting, alert, or signage settings of a Zoom Room. | |
| Get Zoom Rooms Account Profile | get_rooms_account_profile | Get the Zoom Rooms account profile. | |
| Get Zoom Rooms Account Settings | get_rooms_account_settings | Get the Zoom Rooms account settings. | |
| Get Zoom Rooms Location Profile | get_rooms_location_profile | Get a Zoom Rooms location profile. | |
| Get Zoom Rooms Location Settings | get_rooms_location_settings | Get Zoom Rooms location settings. | |
| Get Zoom Rooms Location Structure | get_rooms_location_structure | Get the Zoom Rooms location structure. | |
| List Calendar Resources | list_calendar_resources | List calendar resources belonging to a calendar service. | |
| List Calendar Services | list_calendar_services | List calendar services integrated with Zoom Rooms for the account. | |
| List Content Library | list_content_library | List Zoom Rooms content library items (background images and other content). | |
| List Device Profiles | list_device_profiles | List Zoom Rooms device profiles on the account. | |
| List Digital Signage Contents | list_digital_signage_contents | List a Zoom account’s Zoom Rooms digital signage content (files and folders). | |
| List Digital Signage Playlists | list_digital_signage_playlists | List Zoom Rooms digital signage playlists. | |
| List Playlist Rooms | list_playlist_rooms | List the Zoom Rooms assigned to a digital signage playlist. | |
| List Room Tags | list_room_tags | List all Zoom Rooms tags on the account. | |
| List Zoom Room Devices | list_zoom_room_devices | List the devices associated with a specific Zoom Room. | |
| List Zoom Rooms | list_zoom_rooms | List all Zoom Rooms in an account. | |
| List Zoom Rooms Locations | list_rooms_locations | List Zoom Rooms locations. | |
| Unassign Room Tags | unassign_room_tags | Unassign one or more tags from a Zoom Room. | |
| Update Content Library Item | update_content_library_item | Update a Zoom Rooms content library item (e.g. rename, reassign). | |
| Update Device Profile | update_device_profile | Update an existing Zoom Rooms device profile. | |
| Update Digital Signage Playlist | update_digital_signage_playlist | Update a Zoom Rooms digital signage playlist. | |
| Update Emergency Content | update_emergency_content | Display or hide E911 emergency alert content on Zoom Rooms digital signage. | |
| Update Playlist Rooms | update_playlist_rooms | Assign/update the Zoom Rooms that display a digital signage playlist. | |
| Update Room Tag | update_room_tag | Update an existing Zoom Rooms tag. | |
| Update Zoom Room Device App Version | update_zoom_room_device_app_version | Upgrade, downgrade, or cancel the app version of a Zoom Room device. | |
| Update Zoom Room Profile | update_zoom_room_profile | Update the profile of a specific Zoom Room. | |
| Update Zoom Room Settings | update_zoom_room_settings | Update the meeting, alert, or signage settings of a Zoom Room. | |
| Update Zoom Rooms Account Profile | update_rooms_account_profile | Update the Zoom Rooms account profile. | |
| Update Zoom Rooms Account Settings | update_rooms_account_settings | Update the Zoom Rooms account settings. | |
| Update Zoom Rooms Location Profile | update_rooms_location_profile | Update a Zoom Rooms location profile. | |
| Update Zoom Rooms Location Settings | update_rooms_location_settings | Update Zoom Rooms location settings. | |
| Update Zoom Rooms Location Structure | update_rooms_location_structure | Update the Zoom Rooms location structure hierarchy. |