Zoom Public API Documentation
List user's channels
GET {{baseUrl}}/chat/users/:userId/channels?page_size=10&next_page_token=<string>
Lists a user's chat channels. For user-level apps, pass the Zoom chat channels allow users to communicate via chat in private or public groups. Scopes: Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to list channels of another user in the same Zoom account, the user calling this API must have a role that has the View or Edit permission for the Chat channels feature.me value instead of the userId parameter.chat_channel:read or chat_channel:read:admin
Rate Limit Label: Medium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned from a single API call. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"channels": [
{
"properties": {
"channel_settings": {
"add_member_permissions": 2,
"new_members_can_see_previous_messages_files": "<boolean>",
"posting_permissions": 2,
"mention_all_permissions": 2,
"allow_to_add_external_users": 0
},
"id": "<string>",
"jid": "<string>",
"name": "<string>",
"type": 3,
"channel_url": "<string>"
}
},
{
"properties": {
"channel_settings": {
"add_member_permissions": 2,
"new_members_can_see_previous_messages_files": "<boolean>",
"posting_permissions": 2,
"mention_all_permissions": 1,
"allow_to_add_external_users": 0
},
"id": "<string>",
"jid": "<string>",
"name": "<string>",
"type": 5,
"channel_url": "<string>"
}
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/chat/users/:userId/channels?page_size=10&next_page_token=<string>?page_size=10&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS