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.
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
at_items[] |
Array | No |
Chat mentions object. Use this object to include mentions in the message that will be sent to a channel. |
at_items[].end_position |
Integer | No |
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. |
at_items[].at_type |
Integer | No |
Type of mention. You can use one of the following values:
Valid values:
|
at_items[].at_contact |
String | No |
This field is required if the value of Email address of the contact. |
at_items[].start_position |
Integer | No |
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 | Yes |
The message to be sent. |
to_channel |
String | No |
The Channel Id of the channel where you would like to send a message. |
to_contact |
String | No |
The email address of the contact to whom you would like to send the message. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.