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

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

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

#Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да Идентификатор диалога: числовой ID пользователя или chatXXX для групповых
messageId (path) number да ID сообщения (из ответа POST /v1/chats/:dialogId/messages)

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

Поле Тип Обяз. Описание
message string да Новый текст сообщения (до 20 000 символов)

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

#Примеры

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

Terminal 
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-приложение

Terminal 
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 — личный ключ

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-приложение

javascript 
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()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true при успешном обновлении

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

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

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

422 — Битрикс24 вернул ошибку (сообщение не найдено):

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Message not found"
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 вернул ошибку — сообщение не найдено, недоступно или пустой текст (подробности в message)
403 SCOPE_DENIED Ключ не имеет скоупа im
401 TOKEN_MISSING Ключ не имеет настроенных токенов

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

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

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

Изменяется только текст. Эндпоинт обновляет текст сообщения. Клавиатуру и вложения отправленного сообщения через него не заменить.

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