Delete Message

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

This method is planned to be removed by 7.0.0. Use the /chat.delete endpoint instead.

Delete a message by the message ID.

Method	Requires Auth	Permission	Settings
`deleteMessage`	Yes	`delete-message`	You need to consider two essential settings when deleting messages: `Message_AllowDeleting`: It is represented as a boolean (true/false), which determines whether message deletion is permitted. `Message_AllowDeleting_BlockDeleteInMinutes`: It is represented as an integer and offers more granular control over the deletion functionality. When set to `0`, deletion is allowed without any time restrictions. However, if the value is greater than `0`, there is a time-based restriction where deletion is blocked/disabled after the specified duration has passed. Users with the `delete-message` permission can delete any message, while still adhering to the rules set by the `Message_AllowDeleting_BlockDeleteInMinutes` setting. Alternatively, users with the `force-delete-message` permission can delete any message without adhering to the rules set by the`Message_AllowDeleting_BlockDeleteInMinutes` setting.

Method

Requires Auth

Permission

Settings

deleteMessage

Yes

delete-message

You need to consider two essential settings when deleting messages:

Message_AllowDeleting: It is represented as a boolean (true/false), which determines whether message deletion is permitted.
Message_AllowDeleting_BlockDeleteInMinutes: It is represented as an integer and offers more granular control over the deletion functionality. When set to 0, deletion is allowed without any time restrictions. However, if the value is greater than 0, there is a time-based restriction where deletion is blocked/disabled after the specified duration has passed.

Users with the delete-message permission can delete any message, while still adhering to the rules set by the Message_AllowDeleting_BlockDeleteInMinutes setting.
Alternatively, users with the force-delete-message permission can delete any message without adhering to the rules set by theMessage_AllowDeleting_BlockDeleteInMinutes setting.

Payload parameters

Argument	Example	Required	Description
`message_id`	`64a1f373376181965ab77f54`	Required	The message ID.

Example call

{
    "msg": "method",
    "method": "deleteMessage",
    "id": "42",
    "params": [ 
		{ "_id": "8gMsLe9ApZjo2D2iB"} 
	]
}

Example response

{
    "msg": "result",
    "id": "42"
}

Was this article helpful?

What's Next

Star/Unstar Message

On this page

Payload parameters
Example call
Example response