Delete Message
This method is planned to be removed by 7.0.0. Use the /chat.delete
endpoint instead.
Delete a message by the message id.
Name | Requires Auth | Permission | Setting |
---|---|---|---|
| Yes |
|
|
Settings
There are two essential settings to consider 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 |
---|---|---|---|
|
| Required | The room id |
Example Call
Example Response
Last updated