#Обновить сообщение

PATCH /v1/bots/:botId/messages/:messageId

Обновляет ранее отправленное ботом сообщение. Бот может обновлять только собственные сообщения.

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

Параметр Тип Описание
message string Новый текст сообщения (до 20 000 символов). Поддерживает BB-коды
keyboard array Новая клавиатура. Для удаления передайте "N"
attach array/object Новые ATTACH-блоки
urlPreview boolean Показывать превью ссылок

#Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/bots/42/messages/1502 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Обновлённый текст сообщения",
    "keyboard": [
      {
        "TEXT": "Готово",
        "BG_COLOR_TOKEN": "primary",
        "DISABLED": "Y"
      }
    ]
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/bots/42/messages/1502 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Обновлённый текст сообщения",
    "keyboard": [
      {
        "TEXT": "Готово",
        "BG_COLOR_TOKEN": "primary",
        "DISABLED": "Y"
      }
    ]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1502', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Обновлённый текст сообщения',
    keyboard: [
      {
        TEXT: 'Готово',
        BG_COLOR_TOKEN: 'primary',
        DISABLED: 'Y',
      },
    ],
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages/1502', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Обновлённый текст сообщения',
    keyboard: [
      {
        TEXT: 'Готово',
        BG_COLOR_TOKEN: 'primary',
        DISABLED: 'Y',
      },
    ],
  }),
})

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

#Поля ответа

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

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

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

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

502 — Bitrix24 вернул ошибку (например, сообщение не найдено):

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

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

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

Удаление клавиатуры: передайте "keyboard": "N" чтобы убрать клавиатуру с сообщения.

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