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

Индикатор «печатает»

POST /v1/chats/:dialogId/typing

Показывает остальным участникам чата, что текущий пользователь пишет сообщение, записывает голосовое или видео, отправляет фото или файл.

Параметры

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

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

Поле Тип Обяз. Описание
type string нет Что делает пользователь: writing — пишет, recordingVoice — записывает голосовое, sendingPhoto — отправляет фото, sendingFile — отправляет файл, recordingVideo — записывает видео. По умолчанию writing

Тело можно не передавать. Другие поля тела и любые параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/typing" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "recordingVoice" }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat42/typing" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "type": "recordingVoice" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat42/typing', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ type: 'recordingVoice' }),
})

const { success } = await res.json()
console.log('Индикатор отправлен:', success)

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

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

const { success } = await res.json()
console.log('Индикатор отправлен:', success)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Результат отправки события
data.result boolean true — событие отправлено участникам

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

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

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

400 — неизвестное значение type:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`type` must be one of: writing, recordingVoice, sendingPhoto, sendingFile, recordingVideo."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS type вне пяти значений, другое поле тела или любой параметр запроса. Проверяется до обращения к Битрикс24
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 вернул ошибку, например CHAT_NOT_FOUND, код портала — в error.b24Code
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить текущего пользователя для me: Битрикс24 не вернул его ID
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Индикатор гаснет сам. Событие показывает индикатор на несколько секунд. Пока пользователь продолжает писать, повторяйте вызов — но не чаще, чем нужно индикатору: у эндпоинта нет собственного ограничения частоты, а каждый вызов уходит в Битрикс24.

writing доходит дальше чата. Событие «пишет» получают также открытые линии, которые передают его внешнему клиенту, и чат-боты чата.

Участником не делает. В отличие от чтения чата, вызов не добавляет пользователя в участники.

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