POST /im/chat/messages
Send chatbot messages from your marketplace chatbot app.
Scopes: imchat:bot
Rate Limit Label: Medium
Authorization Flow: Client Credentials Flow
To get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials.
Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request.
You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode({client_id}:{client_sceret})
Next, use the token recieved (access_token) as a bearer token while making the POST /im/chat/messages request to send chatbot messages.
Learn more about how to authorize chatbots in the Chatbot Authorization guide.
Servers
- https://api.zoom.us/v2
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 |
|---|---|---|---|
robot_jid |
String | Yes |
Robot JID created when enabling chatbot features on your marketplace app. |
user_jid |
String | No |
Optional |
content |
Object | Yes |
JSON template describing how the message should be displayed for the user. For more information please see our "Send Message" templates. |
account_id |
String | Yes |
Account ID of the authorized account. |
is_markdown_support |
Boolean | No |
Optional |
to_jid |
String | Yes |
Unique JID of reciever. Can be a group or user. |
visible_to_user |
String | No |
Optional |
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.