Изменить отправленное сообщение imbot.message.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: авторизованный пользователь приложения, которое зарегистрировало чат-бота. Метод работает только с ботами этого приложения.

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Chat.Message.update.

Метод imbot.message.update изменяет ранее отправленное сообщение чат-бота.

Параметры метода

Обязательные параметры отмечены *

Название
Тип

Описание

BOT_ID
integer

Идентификатор чат-бота. Получить можно методом imbot.bot.list.

Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением

MESSAGE_ID*
integer

Идентификатор сообщения, которое нужно изменить. Значение должно быть больше 0.

Для сообщений, которые отправлены ботом через REST, идентификатор возвращает метод imbot.message.add

MESSAGE
string

Новый текст сообщения. Если передать пустое значение, сообщение будет удалено.

Если параметр не передан, текст сообщения не изменится

ATTACH
object
string

Вложение с блоками контента: изображения, ссылки, файлы. Можно передать:

  • строку JSON
  • объект с корневым ключом BLOCKS
  • массив блоков без обертки

Подробнее читайте в разделе Вложения.

Пустое значение или N очищает вложение

KEYBOARD
object
string

Кнопки под сообщением, с которыми может взаимодействовать пользователь.

Подробнее читайте в статье Работа с клавиатурами.

Пустое значение или N отключает вывод кнопок

MENU
object
string

Дополнительные пункты в контекстном меню чата.

Подробнее читайте в статье Контекстное меню.

Пустое значение или N отключает показ дополнительных пунктов

URL_PREVIEW
string

Управляет отображением ссылок: при включении ссылка показывается как «богатая ссылка» с карточкой.

Допустимые значения:

  • Y — включено, значение по умолчанию
  • N — выключено

SKIP_CONNECTOR
string

Пропускает отправку сообщения во внешние коннекторы открытых линий при обновлении MESSAGE.

Допустимые значения:

  • 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,"MESSAGE":"Обновленный текст","URL_PREVIEW":"Y","CLIENT_ID":"**put_your_client_id_here**"}' /
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.update

curl -X POST /
  -H "Content-Type: application/json" /
  -H "Accept: application/json" /
  -d '{"BOT_ID":39,"MESSAGE_ID":19880117,"MESSAGE":"Обновленный текст","URL_PREVIEW":"Y","auth":"**put_access_token_here**"}' /
  https://**put_your_bitrix24_address**/rest/imbot.message.update

try {
  const response = await $b24.callMethod('imbot.message.update', {
    BOT_ID: 39,
    MESSAGE_ID: 19880117,
    MESSAGE: 'Обновленный текст',
    URL_PREVIEW: 'Y',
  });

  const { result } = response.getData();
  console.log('Updated:', result);
} catch (error) {
  console.error('Error updating message:', error);
}

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.message.update',
            [
                'BOT_ID' => 39,
                'MESSAGE_ID' => 19880117,
                'MESSAGE' => 'Обновленный текст',
                'URL_PREVIEW' => 'Y',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Updated: ' . ($result->data() ? 'true' : 'false');
    }
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error updating message: ' . $exception->getMessage();
}

BX24.callMethod(
    'imbot.message.update',
    {
        BOT_ID: 39,
        MESSAGE_ID: 19880117,
        MESSAGE: 'Обновленный текст',
        URL_PREVIEW: 'Y',
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.message.update',
    [
        'BOT_ID' => 39,
        'MESSAGE_ID' => 19880117,
        'MESSAGE' => 'Обновленный текст',
        'URL_PREVIEW' => 'Y',
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo 'Updated: ' . ($result['result'] ? 'true' : 'false');
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.message.update", b24.Params{
	"BOT_ID":      39,
	"MESSAGE_ID":  19880117,
	"MESSAGE":     "Обновленный текст",
	"URL_PREVIEW": "Y",
	"CLIENT_ID":   "**put_your_client_id_here**",
})
if err != nil {
	return fmt.Errorf("imbot.message.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

Обработка ответа

HTTP-код: 200

{
    "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
    }
}

Возвращаемые данные

Название
Тип

Описание

result
boolean

true, если запрос обработан без ошибки

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

{
    "error": "MESSAGE_ID_ERROR",
    "error_description": "Message ID can't be empty"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Значение

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

ATTACH_ERROR

Incorrect attach params

Невалидная структура ATTACH

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Превышен допустимый размер ATTACH — 30 Кб

KEYBOARD_ERROR

Incorrect keyboard params

Невалидная структура KEYBOARD

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

Превышен допустимый размер KEYBOARD — 30 Кб

menu_ERROR

Incorrect menu params

Невалидная структура MENU

MENU_OVERSIZE

You have exceeded the maximum allowable size of menu

Превышен допустимый размер MENU — 30 Кб

CANT_EDIT_MESSAGE

Time has expired for modification or you don't have access

Нет доступа к изменению сообщения или истекло время редактирования — после публикации прошло более трех суток

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Отправить сообщение
Следующая
Удалить сообщение