imbot.chat.user.delete
Исключить участников из чата
Описание
Метод imbot.chat.user.delete исключает пользователя из чата.
Параметры
CHAT_ID
integer
обязательный
Идентификатор чата.
Идентификатор можно получить с помощью метода imbot.chat.get
USER_ID
integer
обязательный
Идентификатор пользователя, которого нужно удалить из чата.
Получить идентификатор пользователя можно с помощью метода imbot.chat.user.list
BOT_ID
integer
необязательный
Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list.
Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением
CLIENT_ID
string
необязательный
Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота
Примеры запроса
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"CHAT_ID":2725,"USER_ID":1269,"CLIENT_ID":"**put_your_client_id_here**"}' /
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.user.delete
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"CHAT_ID":2725,"USER_ID":1269,"auth":"**put_access_token_here**"}' /
https://**put_your_bitrix24_address**/rest/imbot.chat.user.delete
try
{
const response = await $b24.callMethod(
'imbot.chat.user.delete',
{
CHAT_ID: 2725,
USER_ID: 1269,
}
);
const result = response.getData().result;
console.log('User deleted from chat:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'imbot.chat.user.delete',
[
'CHAT_ID' => 2725,
'USER_ID' => 1269
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting chat user: ' . $e->getMessage();
}
BX24.callMethod(
'imbot.chat.user.delete',
{
CHAT_ID: 2725,
USER_ID: 1269,
},
function (result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.chat.user.delete',
[
'CHAT_ID' => 2725,
'USER_ID' => 1269
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.chat.user.delete", b24.Params{
"CHAT_ID": 2725,
"USER_ID": 1269,
"CLIENT_ID": "**put_your_client_id_here**",
})
if err != nil {
return fmt.Errorf("imbot.chat.user.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1771936672,
"finish": 1771936672.409352,
"duration": 0.40935206413269043,
"processing": 0,
"date_start": "2026-02-24T15:37:52+03:00",
"date_finish": "2026-02-24T15:37:52+03:00",
"operating_reset_at": 1771937272,
"operating": 0.23420310020446777
}
}
Возвращаемые данные
result
boolean
true, если пользователь удален из чата
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "USER_ID_EMPTY",
"error_description": "User ID can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
CHAT_ID_EMPTY |
Chat ID can't be empty | Не передан CHAT_ID |
USER_ID_EMPTY |
User ID can't be empty | Не передан USER_ID |
ACCESS_ERROR |
Action unavailable | Операция недоступна для этого чата |
ACCESS_ERROR |
It is forbidden to delete users of this chat | Нельзя удалять пользователей из этого чата |
ACCESS_ERROR |
LEAVE_OWNER_FORBIDDEN | Нельзя удалить владельца чата без передачи прав |
WRONG_REQUEST |
You don't have access or user isn't member in chat | Нет прав на удаление или пользователь не состоит в чате |
BOT_ID_ERROR |
Bot not found | Чат-бот не найден |
APP_ID_ERROR |
Bot was installed by another rest application | Чат-бот установлен другим приложением |

