Zoom API MCP Server

{ "server": { "url": "https://api.zoom.us/v2" }, "authentication": [ { "schema_parameters": { "in": "header" }, "type": "apiKey", "value": "API_KEY" } ], "operations": [ { "description": "Only [master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this API to enable BYOC(Bring your own carrier) option for a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**: \u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e", "name": "update_phone_settings" }, { "description": "After assigning a Zoom phone license to an account, an admin or account owner can proceed with the [initial Zoom phone set up](https://support.zoom.us/hc/en-us/articles/360001297663-Getting-started-with-Zoom-Phone-admin-#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13) using this API. **Scope**:\u003cbr\u003e * `phone:write:admin` `phone:write` **Prerequisites**: \u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "set_up_account" }, { "description": "Using this API, a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) owner can assign SIP trunk(s) to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "post_phone_s_i_p_trunk" }, { "description": "Update details of a SIP trunk that is assigned to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e Business or Enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "update_phone_s_i_p_trunk" }, { "description": "Use this API to add BYOC phone numbers(provided to you by your carrier) to Zoom. **Scope:** `phone:write:admin` or `phone:write` or `phone:master` **Prerequisites:**\u003cbr\u003e * The account must hold a business or enterprise plan and Zoom Phone license. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "add_b_y_o_c_number" }, { "description": "Retrieve [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs) for an account. **Scopes**: `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisite:**\u003cbr\u003e 1. Business or Enterprise account\u003cbr\u003e 2. A Zoom Phone license\u003cbr\u003e 3. Account Owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone Management\u003cbr\u003e", "name": "account_call_logs" }, { "description": "List all Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that are enabled for a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom phone license. \u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_calling_plans" }, { "description": "The [main company number](https://support.zoom.us/hc/en-us/articles/360028553691) can be used by external callers to reach your phone users (by dialing the main company number and the user\u0027s extension). It can also be used by phone users in your account as their caller ID while making calls.\u003cbr\u003e\u003cbr\u003e Use this API to [change the main company number](https://support.zoom.us/hc/en-us/articles/360028553691#h_82414c34-9df2-428a-85a4-efcf7f9e0d72) of an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Account owner or admin permissions\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "change_main_company_number" }, { "description": "A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters. **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`", "name": "list_account_phone_numbers" }, { "description": "A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to get details on a specific Phone number in a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "get_phone_number_details" }, { "description": "Update phone number details. **Scopes:** * `phone:write` `phone:write:admin` * `phone:master` **Prerequisite:** * Paid account **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "update_phone_number_details" }, { "description": "List [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) of an account.\u003cbr\u003e **Scopes:**\u003cbr\u003e * `phone:read:admin` `phone:write:admin` **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges.", "name": "get_phone_recordings" }, { "description": "This API lets you retrieve a list of all the phone template settings previously created. \u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:read:admin` or `phone:read` \u003cbr\u003e**Prerequisites**: \u003cbr\u003e 1. Business or enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "list_setting_templates" }, { "description": "This API lets you create a Zoom Phone setting template for an account. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. Settings include profile, policy and user settings. After creating a phone template, the settings defined via this request will become the default settings for an account. \u003cbr\u003e\u003cbr\u003e **Scope**: * `phone:write:admin` `phone:write` **Prerequisites**: 1. Business or enterprise Zoom account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e \u003cbr\u003e", "name": "add_setting_template" }, { "description": "This API lets you retrieve a specific account phone template previously created. \u003cbr\u003e **Scope**: \u003cbr\u003e * `phone:write:admin` or `phone:write` **Prerequisites**: \u003cbr\u003e 1. Business or Enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "get_setting_template" }, { "description": "Use this API to update or modify profile settings for the phone template. Template type includes **User**, **Auto Receptionist**, or **Call Queue**. After you\u0027ve modified a template, click **User Settings** to set up settings for Call Handling, Desk Phone, and Others. \u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:write:admin` or `phone:write` **Prerequisites**: \u003cbr\u003e 1. Business or Enterprise Account 2. A Zoom Phone license \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "update_setting_template" }, { "description": "List [BYOC SIP trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf) that are assigned to an account. **Scopes**:\u003cbr\u003e * `phone:write:admin` or `phone:master`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or Enterprise Account \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "list_b_y_o_c_s_i_p_trunk" }, { "description": "List all the users on an account who have been assigned Zoom Phone licenses.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Zoom phone license\u003cbr\u003e **Scope:** `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`", "name": "list_phone_users" }, { "description": "Retrieve a user\u0027s [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` **Prerequisites** : 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user" }, { "description": "Update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user\u0027s profile. **Scopes:** `phone:write` `phone:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "update_user_profile" }, { "description": "Retrieve a [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) user\u0027s call logs. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_call_logs" }, { "description": "Delete a user\u0027s [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). **Scopes:** `phone:write`, `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** 1. User must belong to a Business or an Enterprise account. 2. User must hold a Zoom Phone license.", "name": "delete_call_log" }, { "description": "Assign [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "assign_calling_plan" }, { "description": "Unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that was previously assigned to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "unassign_calling_plan" }, { "description": "Assign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "assign_phone_number" }, { "description": "Unassign [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) of a Zoom phone user. \u003cbr\u003e After assigning a phone number, you can remove it if you don\u0027t want it to be assigned to anyone. **Scopes**: `phone:write` `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license 3. User must have been previously assigned a Zoom Phone number.", "name": "unassign_phone_number" }, { "description": "Retrieve a user\u0027s zoom [phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_recordings" }, { "description": "Retrieve a user\u0027s zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_settings" }, { "description": "Remove the shared voicemail access settings that were previously assigned to a user. To view these settings in your Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**: `phone:write:admin`\u003cbr\u003e\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "delete_user_setting" }, { "description": "Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to update the voicemail access permissions of a user. To view these settings in the Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**: \u003cbr\u003e`phone:write:admin`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e Business or Enterprise Account", "name": "update_user_setting" }, { "description": "Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user. To view these settings in the Zoom web portal, navigate to **Admin \u003ePhone System Management\u003e Users \u0026 Rooms**. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail \u0026 Call Recordings**.\u003cbr\u003e **Scope**:`phone:write:admin`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites**: \u003cbr\u003e Business or Enterprise Account", "name": "add_user_setting" }, { "description": "Retrieve a user\u0027s Zoom Phone voicemails. **Scopes:** `phone:read`, `phone:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license", "name": "phone_user_voice_mails" }, { "description": "Delete a [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages) from a Zoom account. **Scope:** `phone:write:admin` or `phone:write` **Prerequisite**: * The account must have activted Zoom Phone license. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e", "name": "delete_voicemail" } ] }