Invite channel members

POST

/chat/users/{userId}/channels/{channelId}/members

A channel can have one or multiple members. Use this API to invite members that are in a user's contact list to a channel. The maximum number of members that can be added at once with this API is 5.

Scope: chat_channel:write:admin

Rate Limit Label: Medium

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/chat/users//channels//members'

响应示例

201 - response

{
    "added_at": "2019-09-27T00:14:46Z",
    "ids": [
        "abc4545fdgfdhg",
        "lgfdkhg123456"
    ]
}

请求参数

Path 参数

channelId

string

必需

Channel ID: Unique Identifier of the channel.

userId

string

必需

Unique identifier of the user who is the owner of this channel.

Body 参数multipart/form-data

members

array [object {1}]

可选

Members of a channel. You can invite up to a max number of 5 members with a single API call.

string <email>

必需

Email adress of the member.

返回响应

🟢201**HTTP Status Code:** `201` Members invited to the channel.

application/json

Body

added_at

string <date-time>

可选

The date and time at which the member(s) are added to the channe.

ids

array[string]

可选

Member Ids of the members.

🟠400**Status Code:** `400` Bad request. **Error Code:** `5301` Request to invite channel members failed. **Error Code:** `200` Unauthorized request. You do not have permission to invite channel members on this user's behalf.

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

List channel members

Remove a member