Изменить сообщение im.message.update
Scope:
imКто может выполнять метод: автор сообщения
Метод im.message.update изменяет текст и параметры уже отправленного сообщения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
MESSAGE_ID* |
Идентификатор сообщения. Идентификатор возвращает метод im.message.add |
|
MESSAGE |
Новый текст сообщения. Если передать пустое значение, сообщение будет удалено. Если параметр не передан, текст сообщения не изменится |
|
Вложение с блоками контента: изображения, ссылки, файлы. Чтобы удалить вложение, передайте Подробнее читайте в разделе Вложения |
|
|
Кнопки под сообщением, с которыми может взаимодействовать пользователь. Чтобы отключить вывод кнопок, передайте Подробнее читайте в статье Работа с клавиатурами |
|
|
Дополнительные пункты в контекстном меню чата. Чтобы отключить показ дополнительных пунктов меню, передайте Подробнее читайте в статье Контекстное меню |
|
|
URL_PREVIEW |
Преобразование ссылок в rich-ссылки. Допустимые значения:
|
|
IS_EDITED |
Флаг отметки «изменено»:
По умолчанию — Параметр применяется при обновлении |
Примеры кода
Как использовать примеры в документации
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 |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "MESSAGE_ID_ERROR",
"error_description": "Message ID can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Message ID can't be empty |
Не передан или некорректен |
|
|
Time has expired for modification or you don't have access |
Нет прав на редактирование сообщения или истек срок изменения |
|
|
Incorrect attach params |
Невалидный объект |
|
|
You have exceeded the maximum allowable size of attach |
Размер |
|
|
Incorrect keyboard params |
Невалидный объект |
|
|
You have exceeded the maximum allowable size of keyboard |
Размер |
|
|
Incorrect menu params |
Невалидный объект |
|
|
You have exceeded the maximum allowable size of menu |
Размер |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Отправить сообщение im.message.add
- Удалить сообщение im.message.delete
- Работа с клавиатурами
- Вложения в сообщениях
- Работа с контекстным меню