Edit a chatbot message

PUT

/im/chat/messages/{message_id}

Chatbot Messages

Edit a message that was sent by your Chatbot app.
After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API.

Scope: 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 received (access_token) as a bearer token while making the PUT /im/chat/messages/{message_id} request to edit a chatbot message.

Learn more about how to authotize chatbots in the Chatbot Authorization guide.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
  "message_id": "201910tryyRFjM_main",
  "robot_jid": "v1pky3tyBBB5pl8q@xmpp.zoom.us",
  "sent_time": "2019-10-17 01:40:24",
  "to_jid": "xghfd@shj.zoom.us",
  "user_jid": "jnrgfjp6w@xmpp.zoom.us"
}

请求参数

Path 参数

message_id

string

必需

Unique Identifier of the message that needs to be updated. This should be retrieved from the response of Send Chatbot Message API.

Body 参数multipart/form-data

account_id

string

必需

The AccountID of the Zoom account to which the message was sent. Retrieve this from the Chatbot request sent to your server as shown in the example here.

content

object

必需

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

is_markdown_support

boolean

可选

Optional

Enable or disable markdown parser to your chatbot message. 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.

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.

返回响应

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

application/json

Body

message_id

string

可选

Unique Identifier of the updated message,

robot_jid

string

可选

The BotJID found in the Chat Subscription Section on the Features page of your App Dashboard.

sent_time

string <date-time>

可选

The date and time at which the message was sent.

to_jid

string

可选

The JID of the Channel or User to whom the message was sent.

user_jid

string

可选

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

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

Delete a chatbot message

Get IM chat sessions