#Индикатор набора

POST /v1/bots/:botId/typing

Показывает индикатор статуса в чате. Вызывайте перед отправкой ответа, чтобы пользователь видел, что бот работает.

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

Параметр Тип Обяз. По умолч. Описание
dialogId string да — ID диалога: числовой ID пользователя для личных, chatXXX для групповых
statusMessageCode string нет — Код статуса действия (см. таблицу ниже). Без параметра — стандартный индикатор «печатает»
duration number нет — Длительность отображения в секундах (1-600)

#Коды статуса

Код Описание
IMBOT_AGENT_ACTION_THINKING Думает
IMBOT_AGENT_ACTION_SEARCHING Ищет
IMBOT_AGENT_ACTION_GENERATING Генерирует
IMBOT_AGENT_ACTION_ANALYZING Анализирует
IMBOT_AGENT_ACTION_PROCESSING Обрабатывает
IMBOT_AGENT_ACTION_TRANSLATING Переводит
IMBOT_AGENT_ACTION_CONNECTING Подключается
IMBOT_AGENT_ACTION_CHECKING Проверяет
IMBOT_AGENT_ACTION_CALCULATING Вычисляет
IMBOT_AGENT_ACTION_READING_DOCS Читает документацию
IMBOT_AGENT_ACTION_COMPOSING Составляет ответ

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/typing \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "statusMessageCode": "IMBOT_AGENT_ACTION_THINKING",
    "duration": 30
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/typing \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "statusMessageCode": "IMBOT_AGENT_ACTION_THINKING",
    "duration": 30
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/typing', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    statusMessageCode: 'IMBOT_AGENT_ACTION_THINKING',
    duration: 30,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/typing', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    statusMessageCode: 'IMBOT_AGENT_ACTION_THINKING',
    duration: 30,
  }),
})

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

#Поля ответа

Поле Тип Описание
data boolean true при успешной отправке

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

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

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

404 — бот не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_NOT_FOUND",
    "message": "Bot 999 not found. Register it first via POST /v1/bots."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

AI-боты: используйте statusMessageCode для информативного статуса. Например, IMBOT_AGENT_ACTION_ANALYZING при обработке запроса, затем IMBOT_AGENT_ACTION_COMPOSING перед отправкой ответа.

Автоматическое скрытие: индикатор исчезает при отправке сообщения ботом или по истечении duration.

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