Get a channel

GET

/chat/channels/{channelId}

Zoom chat channels 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
Rate Limit Label: Medium

Note: This API only supports user-managed OAuth app.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/chat/channels/'

响应示例

200 - response

{
    "id": "ut1234sgfsdf",
    "name": "Leah",
    "type": 1
}

请求参数

Path 参数

channelId

string

必需

Channel ID: Unique Identifier of a channel.

返回响应

🟢200**HTTP Status Code:** `200` Channel returned.

application/json

Body

The channel object represents a Zoom chat [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-).

string

可选

Channel Id.

name

string

可选

Name of the channel.

<= 128 字符

type

enum<integer>

可选

Type of the channel. The value can be one of the following:
1: Private channel. In this type of channel, members must be invited to join a channel.
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.
3: Public channel. Anyone can search for this channel and join the channel.

枚举值:

123

🟠400**HTTP Status Code:** `400` Bad Request **Error Code:** `200` Unauthorized request. You do not have permission to access this user's channel information.

🟠404**Status Code:** `404` Not found. **Error Code:** `4130` Channel does not exist: $channelId.

修改于 2024-04-24 09:06:48

Delete a channel

Update a channel