mcp_config_channel_operations.json•14.1 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to delete a specific channel. **Scope:** `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": "delete_user_level_channel"
},
{
"description": "Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel. **Scope:** `chat_channel:read`\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 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": "get_user_level_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 that you created. **Scope:** `chat_channel:write`\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 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": "update_user_level_channel"
},
{
"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](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to list a user\u0027s chat channels. **Scope**: `chat_channel:read` or `chat_channel:read: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 list channels 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\u003eView or Edit\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": "get_channels"
},
{
"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](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to delete a specific channel. **Scope:** `chat_channel:write:admin`\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": "delete_channel"
},
{
"description": "Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel. **Scope:** `chat_channel:read: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 View or Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e",
"name": "get_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"
}
]
}