List user's channels

v1.0.0

Zoom chat allow users to communicate via chat in private or public groups. Use this API to list a user's chat channels.

Scope: chat_channel:read or chat_channel:read:admin

Note: This API supports both user-managed apps and account-level apps. However, in an account-level , to list channels of another user in the same Zoom account, the user calling this API must have a that has View or Edit permission for the Chat channels feature.

: Medium

Input

{
  "type": "object",
  "properties": {
    "next_page_token": {
      "type": "string"
    },
    "page_size": {
      "type": "integer"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "channels": {
      "type": "array",
      "description": "Chat Channel object(s).",
      "items": {
        "type": "object",
        "properties": {
          "channels_settings": {
            "type": "object",
            "properties": {
              "allow_to_add_external_users": {
                "type": "integer"
              },
              "new_members_can_see_previous_messages_files": {
                "type": "boolean"
              },
              "posting_permissions": {
                "type": "integer"
              }
            }
          },
          "id": {
            "type": "string",
            "description": "Channel ID: Unique identifier of the Channel."
          },
          "name": {
            "type": "string",
            "description": "Name of the channel."
          },
          "type": {
            "type": "integer",
            "description": "Type of the channel. The value can be one of the following:<br>\n`1`: **Private channel.** In this type of channel, members must be invited to join a channel.<br>\n`2`: **Private channel with users that belong to the same Zoom account**. Members in this channel should be invited and the members should be from the same organization.<br>\n`3`: **Public channel.** Anyone can search for this channel and join the channel. External members cannot be invited.<br>\n`4`: **New chat**. This is an instant channel which can be created by adding members to a new chat.<br>\n`5`: **Public channel**, similar to above, except members can invite members of other accounts."
          }
        }
      }
    },
    "next_page_token": {
      "type": "string",
      "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
    },
    "page_size": {
      "type": "integer",
      "description": "The number of records returned with a single API call.\nDefault value: 30."
    },
    "total_records": {
      "type": "integer",
      "description": "The total number of records found."
    }
  }
}