Для AI-агентов: markdown этой страницы — /docs-content/bots/chats/user-delete.md индекс документации — /llms.txt
Удалить участника
DELETE /v1/bots/:botId/chats/:dialogId/users
Удаляет пользователя из чата.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрbotId (path) |
Типnumber | Обяз.да | ОписаниеID бота. Список: GET /v1/bots |
ПараметрdialogId (path) |
Типstring | Обяз.да | ОписаниеID группового чата вида chatXXX. Приходит в поле data.chat.dialogId ответа POST /v1/bots/:botId/chats и в поле chat.dialogId событий бота |
Поля запроса (body)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрuserId |
Типnumber | Обяз.да | ОписаниеID пользователя для удаления |
Примеры
curl — личный ключ
curl -X DELETE https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "userId": 12 }'
curl — OAuth-приложение
curl -X DELETE https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "userId": 12 }'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ userId: 12 }),
})
const { success, data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({ userId: 12 }),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеdata.result |
Типboolean | Описаниеtrue при успешном удалении |
Пример ответа
{
"success": true,
"data": {
"result": true
}
}
Пример ответа при ошибке
404 — бот не найден:
{
"success": false,
"error": {
"code": "BOT_NOT_FOUND",
"message": "Bot 999 not found. Register it first via POST /v1/bots."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_BOT_ID |
ОписаниеbotId не является числом |
| HTTP404 | КодBOT_NOT_FOUND |
ОписаниеБот с таким ID не найден |
| HTTP403 | КодBOT_ACCESS_DENIED |
ОписаниеБот принадлежит другому API-ключу |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеОшибка Битрикс24 (текст ошибки в message) |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа imbot |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч только для чтения — см. права доступа |
| HTTP410 | КодBOT_DISABLED |
ОписаниеБот отключён и не обрабатывает вызовы API. Как вернуть бота — Бот отключён |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеAPI-ключ не имеет настроенных токенов |
Полный список общих ошибок API — Ошибки.
Известные особенности
Идемпотентность: метод возвращает true даже если пользователь уже не в чате.