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

POST /v1/chats/:dialogId/messages

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

#Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да Идентификатор диалога: числовой ID пользователя для личных сообщений, chatXXX — для групповых. Принимает значение me — см. ниже

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

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

Поле Тип Обяз. Описание
message string да Текст сообщения (до 20 000 символов). Поддерживает BB-коды
attach array нет Вложения: карточки, таблицы, изображения, файлы, разделители
keyboard array нет Интерактивные кнопки под сообщением
menu array нет Пункты контекстного меню сообщения
replyId number нет ID цитируемого сообщения
system boolean нет При true — системный стиль (без аватара, authorId = 0)
urlPreview boolean нет При false отключает предпросмотр ссылок в тексте

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

#Примеры

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

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

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

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data number ID созданного сообщения

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

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

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

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

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

#Ошибки

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

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

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

Системные сообщения. При system: true сообщение отображается без аватара отправителя, поле authorId равно 0. Такое сообщение нельзя отредактировать или удалить через API.

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

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