Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Accounts
Billing
Chat Channels
Chat Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Groups
Meetings
PAC
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Site
Common Area Phones
Reports
Roles
Rooms
Rooms Account
Rooms Location
SIP Phone
TrackingField
TSP
Users
Webinars
SIP Connected Audio
Account Events
App Events
Chatbot Events
Meeting Events
Recording Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
post

/im/chat/messages

Send chatbot messages from your marketplace chatbot app.

Scopes: imchat:bot
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.

Authorization

oauth2 - clientCredentials

Request Body

1 Example
Schema
object
robot_jid
string

Robot JID created when enabling chatbot features on your marketplace app.

required
to_jid
string

Unique JID of reciever. Can be a group or user.

required
account_id
string

Account ID of the authorized account.

required
content
object

JSON template describing how the message should be displayed for the user. For more information please see our “Send Message” templates.

required
visible_to_user
string

Optional
Allow a Chatbot to send a message to a group channel, but have only one designated person in that group channel see the message by providing the person’s UserID in this field.

user_jid
string

Optional
The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

is_markdown_support
boolean

Optional
Applies the markdown parser to your chatbot message if the value of this field is set to true.
To learn more, refer to the Chatbot message markdown reference.

Responses

HTTP Status Code: 200
Message Sent.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token