Delete a chatbot message

DELETE

/im/chat/messages/{message_id}

Delete a message that was sent by your 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 received (access_token) as a bearer token while making the DELETE /im/chat/messages/{message_id} request to delete a message.

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

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
    "message_id": "20191017014024747_XYYRFjM_main",
    "robot_jid": "v1pky3qsaoqqwdfdsaf5pl8q@xmppdev.zoom.us",
    "sent_time": "2019-10-17 01:40:24",
    "to_jid": "xxx@conference.xmppdev.zoom.us",
    "user_jid": "jnr_3e_eq4cveeafp3qp6w@xmppdev.zoom.us"
}

请求参数

Path 参数

message_id

string

必需

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.

robot_jid

string

必需

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

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.

返回响应

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

application/json

Body

message_id

string

可选

Unique identifier of the message that was deleted.

robot_jid

string

可选

The BotJID of the Chatbot app. It can be found in the Chat Subscription Section on the Features page of your App Dashboard

sent_time

string

可选

The date and time at which the message was deleted.

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 was 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

Send chatbot messages

Edit a chatbot message