Изменить сообщение im.message.update

Scope: im

Кто может выполнять метод: автор сообщения

Метод im.message.update изменяет текст и параметры уже отправленного сообщения.

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

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

Название
тип

Описание

MESSAGE_ID*
integer

Идентификатор сообщения.

Идентификатор возвращает метод im.message.add

MESSAGE
string

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

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

ATTACH
object
string

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

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

KEYBOARD
object
string

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

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

MENU
object
string

Дополнительные пункты в контекстном меню чата. Чтобы отключить показ дополнительных пунктов меню, передайте N или пустое значение.

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

URL_PREVIEW
string

Преобразование ссылок в rich-ссылки.

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

  • Y — включено
  • N — выключено

IS_EDITED
string

Флаг отметки «изменено»:

  • Y — отметить
  • N — не отмечать

По умолчанию — Y

Параметр применяется при обновлении ATTACH. При изменении MESSAGE метка «изменено» может появиться даже если передан IS_EDITED = 'N'

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34239,"MESSAGE":"Обновленный текст","KEYBOARD":"N"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34239,"MESSAGE":"Обновленный текст","KEYBOARD":"N","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.message.update
        
try
        {
            const response = await $b24.callMethod(
                'im.message.update',
                {
                    MESSAGE_ID: 34239,
                    MESSAGE: 'Обновленный текст',
                    KEYBOARD: 'N'
                }
            );
            
            const result = response.getData().result;
            console.log(result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.message.update',
                    [
                        'MESSAGE_ID' => 34239,
                        'MESSAGE' => 'Обновленный текст',
                        'KEYBOARD' => 'N'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating message: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.message.update',
            {
                MESSAGE_ID: 34239,
                MESSAGE: 'Обновленный текст',
                KEYBOARD: 'N'
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.message.update',
            [
                'MESSAGE_ID' => 34239,
                'MESSAGE' => 'Обновленный текст',
                'KEYBOARD' => 'N'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1772623160,
                "finish": 1772623160.616113,
                "duration": 0.6161129474639893,
                "processing": 0,
                "date_start": "2026-03-04T14:19:20+03:00",
                "date_finish": "2026-03-04T14:19:20+03:00",
                "operating_reset_at": 1772623760,
                "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

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

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

Код

Описание

Значение

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

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

ATTACH_ERROR

Incorrect attach params

Невалидный объект ATTACH

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Размер ATTACH превышает допустимый

KEYBOARD_ERROR

Incorrect keyboard params

Невалидный объект KEYBOARD

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

Размер KEYBOARD превышает допустимый

menu_ERROR

Incorrect menu params

Невалидный объект MENU

MENU_OVERSIZE

You have exceeded the maximum allowable size of menu

Размер MENU превышает допустимый

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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