imbot.message.delete
Удалить сообщение
Описание
Метод imbot.message.delete удаляет сообщение чат-бота.
Параметры
BOT_ID
integer
необязательный
Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list.
Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением
MESSAGE_ID
integer
обязательный
Идентификатор сообщения для удаления. Значение должно быть больше 0.
Для сообщений, которые отправлены ботом через REST, идентификатор возвращает метод imbot.message.add
COMPLETE
string
необязательный
Режим удаления.
Допустимые значения:
- Y — удалить полностью, без отметки об удалении
- N — обычное удаление, значение по умолчанию
CLIENT_ID
string
необязательный
Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота
Примеры запроса
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"BOT_ID":39,"MESSAGE_ID":19880117,"COMPLETE":"N","CLIENT_ID":"**put_your_client_id_here**"}' /
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.delete
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"BOT_ID":39,"MESSAGE_ID":19880117,"COMPLETE":"N","auth":"**put_access_token_here**"}' /
https://**put_your_bitrix24_address**/rest/imbot.message.delete
try {
const response = await $b24.callMethod('imbot.message.delete', {
BOT_ID: 39,
MESSAGE_ID: 19880117,
COMPLETE: 'N',
});
const { result } = response.getData();
console.log('Deleted:', result);
} catch (error) {
console.error('Error deleting message:', error);
}
try {
$response = $b24Service
->core
->call(
'imbot.message.delete',
[
'BOT_ID' => 39,
'MESSAGE_ID' => 19880117,
'COMPLETE' => 'N',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Deleted: ' . ($result->data() ? 'true' : 'false');
}
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error deleting message: ' . $exception->getMessage();
}
BX24.callMethod(
'imbot.message.delete',
{
BOT_ID: 39,
MESSAGE_ID: 19880117,
COMPLETE: 'N',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.message.delete',
[
'BOT_ID' => 39,
'MESSAGE_ID' => 19880117,
'COMPLETE' => 'N',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Deleted: ' . ($result['result'] ? 'true' : 'false');
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.message.delete", b24.Params{
"BOT_ID": 39,
"MESSAGE_ID": 19880117,
"COMPLETE": "N",
"CLIENT_ID": "**put_your_client_id_here**",
})
if err != nil {
return fmt.Errorf("imbot.message.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
{
"result": true,
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+03:00",
"date_finish": "2024-10-11T10:00:00+03:00",
"operating_reset_at": 1762349466,
"operating": 0
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "CANT_EDIT_MESSAGE",
"error_description": "Time has expired for modification or you don't have access"
}
| Код | Описание | Значение |
|---|---|---|
BOT_ID_ERROR |
Bot not found | Бот не найден или у приложения нет доступного бота для автоподстановки BOT_ID |
APP_ID_ERROR |
Bot was installed by another rest application | Переданный BOT_ID принадлежит другому приложению |
MESSAGE_ID_ERROR |
Message ID can't be empty | Не передан корректный идентификатор сообщения MESSAGE_ID |
CANT_EDIT_MESSAGE |
Time has expired for modification or you don't have access | Истекло время удаления сообщения или нет доступа к сообщению |

