Send chatbot messages

POST

/im/chat/messages

Chatbot 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.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/im/chat/messages' \
--form 'account_id=""' \
--form 'content=""' \
--form 'robot_jid=""' \
--form 'to_jid=""'

响应示例

200 - 示例 1

{}

请求参数

Body 参数multipart/form-data

account_id

string

必需

Account ID of the authorized account.

content

object

必需

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

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.

robot_jid

string

必需

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

to_jid

string

必需

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

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.

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.

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Message Sent.

application/json

Body

object {0}

🟠400**HTTP Status Code:** `400` **Bad Request**<br> **Error Code:** `7001`<br> Link does not support markdown format.<br> Edit message does not support markdown format.

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

Update a H.323/SIP device

Delete a chatbot message