Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/inform.md индекс документации — /llms.txt

Сообщить собеседнику в «Не беспокоить»

POST /v1/chats/messages/:messageId/inform

Доставляет ваше сообщение собеседнику по личному чату как важное уведомление, когда у него включён режим «Не беспокоить». Условия проверяет портал: чат личный, вы автор сообщения, собеседник его ещё не видел, сообщение свежее, и у собеседника включён «Не беспокоить».

Параметры

Параметр Тип Обяз. Описание
messageId (path) number да ID сообщения, положительное целое — из ленты чата (GET /v1/chats/:dialogId/messages) или из ответа отправки

Тело и параметры строки запроса не принимаются: любое поле отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/1002/inform \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/messages/1002/inform \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/inform', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const body = await res.json()
console.log(body.success ? 'Уведомление отправлено' : body.error.b24Code)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1002/inform', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const body = await res.json()
console.log(body.success ? 'Уведомление отправлено' : body.error.b24Code)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — уведомление отправлено

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

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

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

422 — у собеседника не включён «Не беспокоить»:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "INFORM_USER_STATUS_ERROR",
    "b24Code": "INFORM_USER_STATUS_ERROR"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, поле тела или параметр строки запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 отказал с кодом WRONG_CHAT_TYPE в error.b24Code — чат не личный
422 BITRIX_ERROR Битрикс24 отказал с кодом INFORM_USER_STATUS_ERROR в error.b24Code — у собеседника не включён «Не беспокоить»
422 BITRIX_ERROR Битрикс24 отказал с другим кодом INFORM_* в error.b24Code — вы не автор сообщения, сообщение уже просмотрено или устарело
422 BITRIX_ERROR Битрикс24 отказал с кодом MESSAGE_NOT_FOUND в error.b24Code — сообщения нет
404 ENTITY_NOT_FOUND Битрикс24 вернул код NOT_FOUND. Код портала — в error.b24Code
403 BITRIX_ACCESS_DENIED У пользователя нет доступа к чату — Битрикс24 отказал с кодом ACCESS_DENIED
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

Отказ — штатный исход. Уведомление имеет смысл, только пока собеседник в «Не беспокоить» и не видел сообщения. Во всех остальных случаях портал отвечает кодом INFORM_*, и это не ошибка интеграции.

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