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

POST /v1/chats/:dialogId/messages

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

Параметры

Алиас me. Вместо числового ID пользователя можно передать строку me: диалог откроется с текущим владельцем ключа. Подробнее — Чаты и сообщения.

Режим v2. format=v2 отправляет сообщение. Тело остаётся плоским — теми же полями, что ниже, — а в data вместо числа приходит объект { id, uuidMap, failureMap }. Режим принимает только поля из таблицы ниже, в том числе отмеченные «только режим v2». Любое другое поле тела, формы в верхнем регистре (MESSAGE, REPLY_ID) и параметры строки запроса кроме format отклоняются с 400 INVALID_PARAMS, поле называется по имени, значение не повторяется. message в режиме v2 — только строка. Сообщение должно что-то содержать: непустой текст. Текст из одних пробелов — только вместе с непустым attach. Без message — непустой attach, stickerParams или block. Иначе — 400 MESSAGE_REQUIRED до обращения к порталу. Пересылка идёт через POST /v1/chats/:dialogId/forward: поле forwardIds в режиме v2 отклоняется с этим адресом, botId — с адресом отправки от бота.

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

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

• Форматирование текста — BB-коды: жирный, курсив, ссылки, цвет
• Клавиатура — интерактивные кнопки под сообщением
• Вложения — карточки, таблицы, изображения, файлы

Примеры

В примерах dialogId равен 42 — числовой ID сотрудника-получателя.

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

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

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

curl -X POST https://vibecode.bitrix24.tech/v1/chats/42/messages \
  -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', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Счёт выставлен. Ожидайте подтверждения.',
  }),
})

const { success, data } = await res.json()
console.log('ID сообщения:', data)

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/messages', {
  method: 'POST',
  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()
console.log('ID сообщения:', data)

curl — режим v2

curl -X POST "https://vibecode.bitrix24.tech/v1/chats/42/messages?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Счёт выставлен. Ожидайте подтверждения.",
    "urlPreview": false
  }'

Поля ответа

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

Обычный режим:

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

Режим v2 — format=v2:

{
  "success": true,
  "data": {
    "id": 36889,
    "uuidMap": [],
    "failureMap": []
  }
}

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

400 — не передан текст сообщения:

{
  "success": false,
  "error": {
    "code": "MESSAGE_REQUIRED",
    "message": "Message is empty. Put the message text in the \"message\" field (or send an \"attach\" block)."
  }
}

Ошибки

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

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

Обрезка длинного текста. Текст длиннее 20 000 символов обрезается до 20 000, в конец добавляется (...).

Код отказа портала. Код отказа Битрикс24 приходит в error.b24Code. В ответе 404 ENTITY_NOT_FOUND это поле есть только в режиме v2.

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

• Сообщения
• Редактировать сообщение
• Удалить сообщение