## Контекст для ботов

`POST /v1/chats/:dialogId/bot-context`

Передаёт ботам чата произвольный объект-контекст. Контекст дополняется данными чата и передаётся обработчикам контекста у ботов, подключённых к чату.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `dialogId` (path) | string | да | ID диалога: `chat123` для группового чата, ID пользователя для личного, `me` — чат с самим собой. `chat123` — поле `id` строки [последних диалогов](/docs/chats/discovery/recent), ID пользователя — из [списка пользователей](/docs/entities/users/list) |

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

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `context` | object | да | Данные для ботов — любой JSON-объект. Массив, строка, число и `null` отклоняются |

Другие поля тела и любые параметры запроса отклоняются с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/bot-context" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"context": {"page": "deal", "dealId": 128}}'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/bot-context" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"context": {"page": "deal", "dealId": 128}}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/bot-context', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ context: { page: 'deal', dealId: 128 } }),
})

const { data } = await res.json()
console.log('Контекст доставлен:', data.result)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/bot-context', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ context: { page: 'deal', dealId: 128 } }),
})

const { data } = await res.json()
console.log('Контекст доставлен:', data.result)
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.result` | boolean | `true` — контекст дошёл до обработчиков ботов |

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

```json
{
  "success": true,
  "data": { "result": true }
}
```

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

422 — в чате нет ботов с обработчиком контекста:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "BOT_CONTEXT_ERROR",
    "b24Code": "BOT_CONTEXT_ERROR"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `context` не передан или не JSON-объект, передано другое поле тела или параметр запроса |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает только на чтение |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено». Код портала — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку. Код портала — в `error.b24Code`. `BOT_CONTEXT_ERROR` — в чате нет ботов, принявших контекст |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | Не удалось определить текущего пользователя для `me` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

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

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

- `context` уходит ботам как есть: платформа не переименовывает его ключи.
- К контексту добавляются тип чата, ID вызывающего, автор чата и сущность, к которой привязан чат.
- Вызов может сделать вызывающего участником чата, если чат разрешает автовступление.

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

- [Бот-платформа](/docs/bots)
- [Служебные методы](/docs/chats/service)
