Create a channel - Zoom API

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.
Scopes:chat_channel:write or chat_channel:write:admin

Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a role that has Edit permission for the Chat channels feature.

Rate Limit Label: Medium

请求参数

Path 参数

userId

string

必需

Unique identifier of the user.

Body 参数multipart/form-data

members

array [object {1}]

可选

Member(s) to include in the channel. A max of 5 members can be added to the channel at once with this API.

string <email>

必需

Member's email address.

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.
4: New chat. This is an instant channel which can be created by adding members to a new chat.

枚举值:

123

返回响应

🟢201**Status Code**: `201` Channel created.

application/json

Body

string

可选

Channel ID: Unique Identifier of the Channel.

jid

string

可选

Channel JID.

name

string

可选

Channel name.

type

integer

可选

Channel type.

🟠400**HTTP Status Code:** `400` Not found. **Error Code**: `5301` Request to create a channel failed.

🟠404**HTTP Status Code:** `404` **Error Code**: `1001` User does not exist: $userId.