Удалить файл из папки чата im.disk.file.delete

Scope: im

Кто может выполнять метод: участник чата, который отправил файл

Метод im.disk.file.delete удаляет файл из папки чата. Удалить файл может только пользователь — участник чата, который отправил файл. Другие участники чата не могут удалить файл.

После удаления в чате вместо файла отображается текст Сообщение удалено.

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

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

Название
тип

Описание

CHAT_ID*
integer

Идентификатор чата

FILE_ID*
integer

Идентификатор файла

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":1489,"FILE_ID":5163}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.disk.file.delete
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":1489,"FILE_ID":5163,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.disk.file.delete
        
try
        {
            const response = await $b24.callMethod(
                'im.disk.file.delete',
                {
                    CHAT_ID: 1489,
                    FILE_ID: 5163
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.disk.file.delete',
                    [
                        'CHAT_ID' => 1489,
                        'FILE_ID' => 5163,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.disk.file.delete',
            {
                CHAT_ID: 1489,
                FILE_ID: 5163
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.disk.file.delete',
            [
                'CHAT_ID' => 1489,
                'FILE_ID' => 5163,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1772194631,
                "finish": 1772194631.786718,
                "duration": 0.7867178916931152,
                "processing": 0,
                "date_start": "2026-02-27T15:17:11+03:00",
                "date_finish": "2026-02-27T15:17:11+03:00",
                "operating_reset_at": 1772195231,
                "operating": 0.2657620906829834
            }
        }

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

Название
тип

Описание

result
boolean

Возвращает true:

  • если файл успешно удален,
  • пользователь является участником чата, но не отправлял файл. Файл в этом случае не удалится.

Метод возвращает false:

  • если у пользователя нет доступа к чату,
  • указан неверный CHAT_ID или FILE_ID

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "FILE_ID_EMPTY",
            "error_description": "File ID can't be empty"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус

Код

Описание

Значение

400

CHAT_ID_EMPTY

Chat ID can't be empty

Не передан или передан пустым обязательный параметр CHAT_ID

400

FILE_ID_EMPTY

File ID can't be empty

Не передан или передан пустым обязательный параметр FILE_ID

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Сохранить файл на свой диск
Следующая
Получить папку хранения файлов чата