Удалить участника из чата imbot.v2.Chat.User.delete

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.Chat.User.delete удаляет участника из чата. По умолчанию бот должен быть менеджером или владельцем чата — роли описаны в разделе Роли в чате.

Если пользователь не является участником чата, метод вернет true (идемпотентное поведение).

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
botId* `integer`	ID бота
botToken `string`	Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен. Передавайте тот же `botToken`, который указали при регистрации бота
dialogId* `string`	ID группового чата в формате dialogId: `chat{chatId}`
userId* `integer`	ID пользователя для удаления

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","userId":1}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.User.delete

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"dialogId":"chat5","userId":1,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.User.delete

try {
  const response = await $b24.callMethod('imbot.v2.Chat.User.delete', {
    botId: 456,
    dialogId: 'chat5',
    userId: 1,
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.chat.user.delete(
        bot_id=456,
        dialog_id="chat5",
        user_id=1,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.v2.Chat.User.delete',
            [
                'botId' => 456,
                'dialogId' => 'chat5',
                'userId' => 1,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error: ' . $exception->getMessage();
}

BX24.callMethod(
    'imbot.v2.Chat.User.delete',
    {
        botId: 456,
        dialogId: 'chat5',
        userId: 1,
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.v2.Chat.User.delete',
    [
        'botId' => 456,
        'dialogId' => 'chat5',
        'userId' => 1,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo 'User removed';
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Chat.User.delete", b24.Params{
	"botId":    456,
	"botToken": "my_bot_token",
	"dialogId": "chat5",
	"userId":   1,
})
if err != nil {
	return fmt.Errorf("imbot.v2.Chat.User.delete: %w", err)
}

var item struct {
	Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00"
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Результат операции
result.result `boolean`	`true` при успешном удалении
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "ACCESS_DENIED"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код	Описание	Значение
`BOT_TOKEN_NOT_SPECIFIED`	Bot token not specified (botToken is required for webhook auth)	Не указан `botToken`. Обязателен при авторизации через вебхук
`BOT_ID_REQUIRED`	botId is required	Не указан `botId`
`BOT_NOT_FOUND`	Bot not found	Бот не найден
`BOT_OWNERSHIP_ERROR`	Bot was installed by another rest application	Бот зарегистрирован другим приложением
`CHAT_NOT_FOUND`	CHAT_NOT_FOUND	Чат с указанным `dialogId` не найден
`ACCESS_DENIED`	ACCESS_DENIED	У бота нет роли, которой разрешено удалять участников в этом чате или это личный чат
`USER_INVITED_FROM_STRUCTURE`	USER_INVITED_FROM_STRUCTURE	Пользователь добавлен в чат синхронизацией со структурой компании, удалить его нельзя

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Получить список участников чата

Добавить менеджеров чата

Удалить участника из чата imbot.v2.Chat.User.delete

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение