Get a channel

v1.0.0

Zoom chat 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
: Medium

Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has View or Edit permission for Chat Channels.

Input

{
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "channelId",
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The channel object represents a Zoom chat [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-). ",
  "properties": {
    "id": {
      "type": "string",
      "description": "Channel Id."
    },
    "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 members that belong to one 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.<br>",
      "enum": [
        1,
        2,
        3
      ]
    }
  }
}