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

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

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

Scope: im

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

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

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

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

Название
тип

Описание

MESSAGE_ID*
integer

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

Идентификатор возвращают методы im.message.add и im.dialog.messages.get.

Изменить можно только свое сообщение и только в течение трех суток после отправки. Пересланное сообщение изменить нельзя

MESSAGE
string

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

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

ATTACH
object
string

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

Передайте объект с массивом блоков в ключе BLOCKS, например {"BLOCKS":[{"MESSAGE":"Текст блока"}]}, или сам массив блоков. Чтобы удалить вложение, передайте N или пустое значение.

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

KEYBOARD
object
string

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

Передайте объект с массивом кнопок в ключе BUTTONS, например {"BUTTONS":[{"TEXT":"Открыть","LINK":"https://example.com"}]}, или сам массив кнопок. Чтобы убрать кнопки, передайте N или пустое значение.

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

MENU
object
string

Свои пункты в контекстном меню сообщения, например ссылка или копирование текста.

Передайте объект с массивом пунктов в ключе ITEMS, например {"ITEMS":[{"TEXT":"Открыть","LINK":"https://example.com"}]}, или сам массив пунктов. Чтобы убрать свои пункты, передайте N или пустое значение.

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

URL_PREVIEW
string

Показывать ли под ссылкой в сообщении карточку с заголовком, описанием и картинкой страницы.

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

  • Y — показывать карточку
  • N — не показывать

IS_EDITED
string

Показывать ли у сообщения метку «изменено»:

  • Y — показать
  • N — не показывать

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

Параметр действует при изменении ATTACH. При изменении MESSAGE метка может появиться, даже если передать N

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"MESSAGE_ID":34239,"MESSAGE":"Обновленный текст"}' \
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":"Обновленный текст","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.message.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'im.message.update',
    params: {
      MESSAGE_ID: 34239,
      MESSAGE: 'Обновленный текст',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Message updated:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateMessage() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.message.update',
        params: {
          MESSAGE_ID: 34239,
          MESSAGE: 'Обновленный текст',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Message updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.message.update(
        message_id=34239,
        message="Обновленный текст",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'im.message.update',
            [
                'MESSAGE_ID' => 34239,
                'MESSAGE' => 'Обновленный текст'
            ]
        );

    $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: 'Обновленный текст'
    },
    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' => 'Обновленный текст'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.message.update", b24.Params{
	"MESSAGE_ID": 34239,
	"MESSAGE":    "Обновленный текст",
})
if err != nil {
	return fmt.Errorf("im.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": 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, если запрос выполнен без ошибки. Если передан только MESSAGE_ID, метод тоже вернет 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

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

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

Статус

Код

Описание

Значение

400

MESSAGE_ID_ERROR

Message ID can't be empty

Параметр MESSAGE_ID не передан или его значение не больше 0

403

CANT_EDIT_MESSAGE

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

Сообщение не найдено, удалено, переслано, отправлено другим пользователем или больше трех суток назад

400

ATTACH_ERROR

Incorrect attach params

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

400

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

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

400

KEYBOARD_ERROR

Incorrect keyboard params

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

400

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

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

400

menu_ERROR

Incorrect menu params

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

400

MENU_OVERSIZE

You have exceeded the maximum allowable size of menu

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

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

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

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

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