Send a chat message

POST

/chat/users/{userId}/messages

Send chat messages on Zoom to either an individual user who is in your contact list or to a channel of which you are a member. To send a message to a contact, provide the contact's email address in the to_contact field. Similary, to send a message to a channel, provide the Channel Id of the Channel in to_channel field.

Scopes: chat_message:write, chat_message:write:admin
Rate Limit Label: Medium

Note: 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 Messages.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/chat/users//messages' \
--form 'message=""'

响应示例

201 - response

{
    "id": "ex35785hgdfjgt"
}

请求参数

Path 参数

userId

string

必需

Body 参数multipart/form-data

at_items

array [object {4}]

可选

Chat mentions object. Use this object to include mentions in the message that will be sent to a channel.

at_contact

string

可选

This field is required if the value of at_type field is set to 1.

Email address of the contact.

at_type

enum<integer>

可选

Type of mention. You can use one of the following values:

1: Mention a contact.

2: Mention "all" to notify everyone in the channel.

枚举值:

end_position

integer

可选

End position of the mention.

Example message: "@Shrijana How are you?"
In this case, the end position of the mention "@Shrijana" is 8. Hence, the value of this field will be 8.

start_position

integer

可选

Start position of the mention("@") in the message string.

For example if you want to include the mention at the beginning of the message, the value for this field will be 0.

Example message: "@Shrijana How are you?"

message

string

必需

The message to be sent.

<= 1024 字符

to_channel

string

可选

The Channel Id of the channel where you would like to send a message.

to_contact

string

可选

The email address of the contact to whom you would like to send the message.

返回响应

🟢201**Status Code:** `201` Message sent.

application/json

Body

string

可选

Message ID: Unique Identifier of the message.

🟠400**HTTP Status Code:** `400` Bad request. **Error Code:** `5301` Message sending failed.

🟠404**HTTP Status Code:** `404` **Error Code**: `1001` User does not exist: $to_contact. **Error Code**: `4130` Channel does not exist: $to_channel.

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

List user's chat messages

Delete a message