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

`POST /v1/openlines/crm/messages`

Отправляет сообщение в чат открытой линии, привязанный к карточке CRM. Сообщение уходит клиенту в его мессенджер от имени указанного сотрудника или бота.

**Важно:** сообщение получает реальный клиент. Перед вызовом проверьте, что `chatId` относится к нужному диалогу.

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `crmEntityType` | string | да | Тип карточки CRM: `lead`, `deal`, `company` или `contact`. Регистр не важен |
| `crmEntityId` | number | да | ID карточки CRM. Списки: [`GET /v1/leads`](/docs/entities/leads/list), [`GET /v1/deals`](/docs/entities/deals/list), [`GET /v1/companies`](/docs/entities/companies/list), [`GET /v1/contacts`](/docs/entities/contacts/list) |
| `userId` | number | да | ID сотрудника или бота, от имени которого отправляется сообщение. Сотрудники: [`GET /v1/users`](/docs/entities/users/list), боты: поле `data.bots[].id` в ответе [`GET /v1/bots`](/docs/bots/management/list) |
| `chatId` | number | да | Идентификатор чата открытой линии этой карточки — положительное целое без префикса `chat`. Список: [`GET /v1/openlines/crm/chats`](/docs/openlines/crm-chats) с `activeOnly=false` |
| `message` | string | да | Текст сообщения. Строка из одних пробелов не принимается |

Числовые поля принимают и строку из цифр.

## Примеры

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/crm/messages \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "crmEntityType": "deal",
    "crmEntityId": 42,
    "userId": 7,
    "chatId": 123,
    "message": "Здравствуйте! Ваш заказ готов к выдаче."
  }'
```

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/openlines/crm/messages \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "crmEntityType": "deal",
    "crmEntityId": 42,
    "userId": 7,
    "chatId": 123,
    "message": "Здравствуйте! Ваш заказ готов к выдаче."
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/crm/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    crmEntityType: 'deal',
    crmEntityId: 42,
    userId: 7,
    chatId: 123,
    message: 'Здравствуйте! Ваш заказ готов к выдаче.',
  }),
})

const { success, data, error } = await res.json()
if (!success) throw new Error(`${error.code}: ${error.message}`)
console.log('ID сообщения:', data.messageId)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/openlines/crm/messages', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    crmEntityType: 'deal',
    crmEntityId: 42,
    userId: 7,
    chatId: 123,
    message: 'Здравствуйте! Ваш заказ готов к выдаче.',
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true`, когда сообщение отправлено |
| `data.chatId` | number | Идентификатор чата из запроса |
| `data.messageId` | number | ID отправленного сообщения в чате |

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

```json
{
  "success": true,
  "data": {
    "chatId": 123,
    "messageId": 456
  }
}
```

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

404 — чат не относится к указанной карточке CRM:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "CRM chat not found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `crmEntityType` не передан или вне списка, `crmEntityId` или `userId` не передан или не положительное целое, либо тело запроса не JSON-объект |
| 400 | `INVALID_JSON_BODY` | Тело запроса не разбирается как JSON |
| 400 | `INVALID_CHAT_ID` | `chatId` не положительное целое, в том числе форма `chat123` |
| 400 | `MISSING_REQUIRED_FIELDS` | Не передан `chatId`, или `message` не передан, не строка, пустой либо состоит из одних пробелов |
| 404 | `ENTITY_NOT_FOUND` | Сообщение `CRM chat not found`: у карточки CRM нет чата с таким `chatId`, включая завершённые. Проверка идёт до отправки, сообщение не отправлено |
| 404 | `ENTITY_NOT_FOUND` | Сообщение `Record not found`: Битрикс24 не нашёл чат при отправке |
| 403 | `BITRIX_ACCESS_DENIED` | У сотрудника, от имени которого идёт вызов, нет прав на карточку CRM или на отправку сообщения |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в отправке, его код приходит в `error.b24Code` |
| 502 | `OPENLINE_OPERATOR_FAILED` | Битрикс24 не вернул ID сообщения. Сообщение при этом могло быть отправлено |
| 502 | `OPENLINE_OPERATOR_FAILED` | Список чатов карточки пришёл в неожиданной форме. Проверка идёт до отправки, сообщение не отправлено |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `imopenlines` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Ключ не опознан |
| 401 | `TOKEN_MISSING` | У личного ключа нет доступа к порталу Битрикс24, у ключа приложения не передан токен сессии в `Authorization` |
| 429 | `RATE_LIMITED` | Превышен лимит 120 запросов в минуту на портал. Лимит делится между репликами платформы, поэтому код может прийти раньше 120-го запроса. Действующее значение для ключа — в заголовке `x-ratelimit-limit`, остаток — в `x-ratelimit-remaining` |
| 429 | `RATE_LIMITED` | Битрикс24 отклонил вызов по лимиту частоты запросов к порталу. В ответе приходит заголовок `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или соединение с ним оборвалось до полного ответа |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 принял вызов, но не ответил за отведённое время. Сообщение при этом могло быть отправлено |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- **Чат проверяется до отправки.** Перед отправкой Вайбкод сверяет `chatId` со всеми чатами карточки, включая завершённые диалоги.
- **Повтор после сбоя.** После `502 OPENLINE_OPERATOR_FAILED` или `503 BITRIX_TIMEOUT` сообщение могло дойти до клиента. Повторный вызов отправит его ещё раз, поэтому перед повтором проверьте переписку диалога.

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

- [Чаты по карточке CRM](/docs/openlines/crm-chats)
- [Участники CRM-чата](/docs/openlines/crm/members)
- [Создать лид из обращения](/docs/openlines/crm/lead)
- [История сессии](/docs/openlines/history)