mcp_config_channel_member_management.json•11.7 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "If you\u0027re no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eThis API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "leave_channel"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it. \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eThis API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e **Scope:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "join_channel"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e",
"name": "remove_a_user_level_channel_member"
},
{
"description": "Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.\u003cbr\u003e **Scopes**:`chat_channel:write` or `chat_channel:write:admin`\u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API supports both user-managed apps and account-level apps. However, in an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003erole\u003c/a\u003e that has \u003cb\u003eEdit\u003c/b\u003e permission for the Chat channels feature.\u003c/p\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "create_channel"
},
{
"description": "Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel created by a user. \u003cbr\u003e\u003cbr\u003e **Scope:** `chat_channel:write:admin`\t\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e \u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channel\u003c/b\u003e.\u003c/p\u003e",
"name": "update_channel"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. List all the members of a channel using this API. \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has View or Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e **Scopes:** `chat_channel:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_channel_members"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to invite members that are in a user\u0027s contact list to a channel. The maximum number of members that can be added at once with this API is 5. **Scope:** `chat_channel:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e",
"name": "invite_channel_members"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e",
"name": "remove_a_channel_member"
},
{
"description": "If a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group\u0027s settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.\u003cbr\u003e\u003cbr\u003e Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or higher account\u003cbr\u003e **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_a_group_member"
},
{
"description": "Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "unassign_all_members"
},
{
"description": "Add phone users and/or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) as members to a specific Call Queue.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "add_members_to_call_queue"
},
{
"description": "Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "unassign_member_from_call_queue"
},
{
"description": "Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group\u0027s phone number and voicemail. Use this API to unassign **a specific member** from a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_a_member_s_l_g"
}
]
}