Редактировать сообщение

PATCH /v1/chats/:dialogId/messages/:messageId

Обновляет текст ранее отправленного сообщения. Восстановить исходный текст после редактирования через API нельзя — создавайте новое сообщение при необходимости.

Параметры

Режим v2. format=v2 правит сообщение: кроме текста меняются блоки attach, keyboard, menu, block — вместе с текстом или без него, — а urlPreview включает и выключает превью ссылки. В data приходит { "result": true } вместо true. Без message текст остаётся прежним. Правка, которая могла бы стать удалением, отклоняется до обращения к порталу, как и в обычном режиме: текст, пустой по правилу Битрикс24, — 400 MESSAGE_REQUIRED. Снятие блока ([], {} или "") без нового текста в том же запросе — 400 INVALID_PARAMS, потому что сообщение без текста и блоков было бы удалено, а есть ли у сообщения текст, платформа не видит. Нужно хотя бы одно из полей message, attach, keyboard, menu, block. message в режиме v2 — только строка. Любое другое поле тела и параметры строки запроса кроме format отклоняются с 400 INVALID_PARAMS, botId — с адресом правки от бота. Сообщение должно принадлежать диалогу из пути: после проверки входа платформа читает этот диалог, не вступая в чат, и, если сообщения в нём нет, отвечает 404 ENTITY_NOT_FOUND, ничего не меняя. Алиас me определяется до этой проверки. Обычный режим dialogId не проверяет.

Поля запроса (body)

Оформление сообщения

• Форматирование текста — BB-коды в тексте сообщения

Примеры

curl — личный ключ

curl -X PATCH https://vibecode.bitrix24.tech/v1/chats/42/messages/36889 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Счёт подтверждён. Спасибо."
  }'

curl — OAuth-приложение

curl -X PATCH https://vibecode.bitrix24.tech/v1/chats/42/messages/36889 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Счёт подтверждён. Спасибо."
  }'

JavaScript — личный ключ

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/messages/36889', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Счёт подтверждён. Спасибо.',
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth-приложение

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/messages/36889', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Счёт подтверждён. Спасибо.',
  }),
})

const { success, data } = await res.json()

curl — режим v2

curl -X PATCH "https://vibecode.bitrix24.tech/v1/chats/42/messages/36889?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyboard": [{ "TEXT": "Открыть счёт", "LINK": "https://example.com/invoice" }]
  }'

Поля ответа

Пример ответа

{
  "success": true,
  "data": true
}

Пример ответа при ошибке

422 — сообщение не найдено, время на изменение истекло или нет прав:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Time has expired for modification or you don't have access",
    "b24Code": "CANT_EDIT_MESSAGE"
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

Известные особенности

Пустой текст — не обновление. Текст, пустой по правилу Битрикс24, удалил бы сообщение, поэтому такой запрос отклоняется до обращения к порталу — см. MESSAGE_REQUIRED в таблице ошибок. Удалить сообщение — DELETE /v1/chats/:dialogId/messages/:messageId. Число в message принимается и записывается как текст.

В Битрикс24 уходит только message. В обычном режиме другие поля тела запроса не передаются на портал — в том числе собственные ключи Битрикс24 в верхнем регистре. В режиме v2 уходят поля из таблицы, остальные отклоняются. Портал сравнивает имена параметров без учёта регистра, и действует последний ключ: алиас вроде Message: "" рядом с MESSAGE удалял бы сообщение.

Системные сообщения нельзя редактировать. Сообщения, отправленные с system: true, имеют authorId = 0. Изменить их нельзя — в ответе вернётся ошибка.

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

Смотрите также

• Сообщения
• Отправить сообщение
• Удалить сообщение
• Читать сообщения