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

POST /v1/bots/:botId/messages

Отправляет сообщение от имени бота в указанный диалог. Текст поддерживает BB-коды, к сообщению можно прикрепить клавиатуру и ATTACH-блоки.

#Параметры

Параметр Тип Обяз. По умолч. Описание
botId (path) number да — ID бота
dialogId string да — ID диалога: числовой ID пользователя для личных сообщений, chatXXX для групповых
fields.message string да — Текст сообщения (до 20 000 символов). Поддерживает BB-коды
fields.keyboard array нет — Интерактивная клавиатура
fields.attach array/object нет — ATTACH-блоки rich-контента
fields.replyId number нет — ID сообщения для цитирования
fields.forwardIds object нет — Сообщения для пересылки: {uuid: messageId}, где uuid — произвольная строка-ключ, messageId — ID исходного сообщения. Максимум 100. В ответе uuidMap вернёт {uuid: newMessageId}
fields.system boolean нет false Системное сообщение (другой стиль, без аватара бота)
fields.urlPreview boolean нет true Показывать превью ссылок в тексте
fields.templateId string нет — UUID шаблона сообщения

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/messages \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "fields": {
      "message": "[b]Задача #42[/b]\nСтатус: выполнено",
      "keyboard": [
        {
          "TEXT": "Открыть задачу",
          "LINK": "https://portal.bitrix24.ru/tasks/42/",
          "BG_COLOR_TOKEN": "primary"
        }
      ]
    }
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/messages \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "fields": {
      "message": "[b]Задача #42[/b]\nСтатус: выполнено",
      "keyboard": [
        {
          "TEXT": "Открыть задачу",
          "LINK": "https://portal.bitrix24.ru/tasks/42/",
          "BG_COLOR_TOKEN": "primary"
        }
      ]
    }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    fields: {
      message: '[b]Задача #42[/b]\nСтатус: выполнено',
      keyboard: [
        {
          TEXT: 'Открыть задачу',
          LINK: 'https://portal.bitrix24.ru/tasks/42/',
          BG_COLOR_TOKEN: 'primary',
        },
      ],
    },
  }),
})

const { success, data } = await res.json()
console.log('Message ID:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    fields: {
      message: '[b]Задача #42[/b]\nСтатус: выполнено',
      keyboard: [
        {
          TEXT: 'Открыть задачу',
          LINK: 'https://portal.bitrix24.ru/tasks/42/',
          BG_COLOR_TOKEN: 'primary',
        },
      ],
    },
  }),
})

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

#Поля ответа

Поле Тип Описание
id number ID созданного сообщения
uuidMap array Маппинг UUID при пересылке (пустой массив если без forwardIds)

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

JSON 
{
  "success": true,
  "data": {
    "id": 36357,
    "uuidMap": []
  }
}

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

404 — бот не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_NOT_FOUND",
    "message": "Bot 999 not found. Register it first via POST /v1/bots."
  }
}

#Ошибки

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. Такие сообщения нельзя обновить или удалить через бота.

Текст обрезается: если сообщение длиннее 20 000 символов, Bitrix24 обрежет текст и добавит (...).

Пересылка (forwardIds): формат — объект {uuid: messageId}, где uuid — произвольная строка, а messageId — ID исходного сообщения. Бот может пересылать только сообщения из чатов, где он является участником.

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