Удалить отправленные сообщения imconnector.delete.messages

Scope: imopenlines

Кто может выполнять метод: любой пользователь

Метод imconnector.delete.messages удаляет сообщения из открытой линии, которые были переданы внешней системой.

Метод работает только в контексте приложения.

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

Для удаления передавайте message.id и chat.id, которые использовали при отправке сообщений методом imconnector.send.messages.

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

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

Название `тип`	Описание
CONNECTOR* `string`	Строковый код коннектора, который задали в параметре `ID` при вызове imconnector.register
LINE* `integer`	Идентификатор открытой линии. Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get
MESSAGES* `array`	Массив сообщений для удаления. Каждый элемент массива — объект сообщения с тремя обязательными блоками: `user`, `message`, `chat`. Структура объекта подробно описана ниже

Параметр MESSAGES

Название `тип`	Описание
user `object`	Данные пользователя внешней системы. Структура объекта подробно описана ниже
message `object`	Данные сообщения внешней системы. Структура объекта подробно описана ниже
chat `object`	Данные чата или канала внешней системы. Структура объекта подробно описана ниже

Объект user

Название
тип

Описание

id*
string

Идентификатор пользователя во внешней системе.

Рекомендуется передавать то же значение, которое использовали в user.id метода imconnector.send.messages

Объект message

Название
тип

Описание

id*
string

Идентификатор сообщения во внешней системе, которое нужно удалить.

Рекомендуется передавать то же значение, которое использовали в message.id метода imconnector.send.messages

Объект chat

Название
тип

Описание

id*
string

Идентификатор чата или канала во внешней системе.

Рекомендуется передавать то же значение, что и в chat.id метода imconnector.send.messages

Примеры кода

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

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONNECTOR": "myconnector",
            "LINE": 107,
            "MESSAGES": [
              {
                "user": {"id": "ext-user-42"},
                "message": {"id": "ext-msg-1001"},
                "chat": {"id": "channel-123"}
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.delete.messages

const payload = {
          CONNECTOR: 'myconnector',
          LINE: 107,
          MESSAGES: [
            {
              user: { id: 'ext-user-42' },
              message: { id: 'ext-msg-1001' },
              chat: { id: 'channel-123' },
            },
          ],
        };
        
        const response = await $b24.callMethod('imconnector.delete.messages', payload);
        console.log(response.getData());

$result = $b24Service->core->call(
            'imconnector.delete.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => ['id' => 'ext-user-42'],
                        'message' => ['id' => 'ext-msg-1001'],
                        'chat' => ['id' => 'channel-123'],
                    ],
                ],
            ]
        );

BX24.callMethod(
          'imconnector.delete.messages',
          {
            CONNECTOR: 'myconnector',
            LINE: 107,
            MESSAGES: [
              {
                user: { id: 'ext-user-42' },
                message: { id: 'ext-msg-1001' },
                chat: { id: 'channel-123' },
              },
            ],
          },
          function(result) {
            console.log(result.data());
          }
        );

$result = CRest::call(
            'imconnector.delete.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => ['id' => 'ext-user-42'],
                        'message' => ['id' => 'ext-msg-1001'],
                        'chat' => ['id' => 'channel-123'],
                    ],
                ],
            ]
        );

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

HTTP-статус: 200

{
            "result": {
                "SUCCESS": true,
                "DATA": {
                    "RESULT": [
                        {
                            "user": "585",
                            "message": {
                                "id": "ext-msg-1001"
                            },
                            "chat": {
                                "id": "channel-123"
                            },
                            "SUCCESS": true
                        }
                    ]
                }
            },
            "time": {
                "start": 1773267564,
                "finish": 1773267565.070724,
                "duration": 1.0707240104675293,
                "processing": 1,
                "date_start": "2026-03-11T14:19:24+03:00",
                "date_finish": "2026-03-11T14:19:25+03:00",
                "operating_reset_at": 1773268164,
                "operating": 0.113616943359375
            }
        }

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

Название `тип`	Описание
SUCCESS `boolean`	Возвращает `true` в случае успешного удаления сообщения
DATA `object`	Данные обработки сообщений. Структура объекта подробно описана ниже
time `time`	Информация о времени выполнения запроса

Объект DATA

Название
тип

Описание

RESULT
array

Массив результатов по каждому элементу MESSAGES

Структура элемента подробно описана ниже

Объект RESULT[]

Название `тип`	Описание
user `string`	Внутренний идентификатор пользователя Битрикс24
message `object`	Данные удаляемого сообщения (подробное описание)
chat `object`	Данные чата или канала (подробное описание)
SUCCESS `boolean`	Признак успешной обработки текущего элемента массива
ERRORS `array`	Массив текстов ошибок по текущему элементу, возвращается при `SUCCESS = false`

Объект message

Название `тип`	Описание
id `string`	Идентификатор сообщения во внешней системе, которое передавалось в `MESSAGES[].message.id`
date `integer`	Время сообщения в Unix Timestamp, если это поле было передано во входных данных
text `string`	Текст сообщения, если это поле было передано во входных данных
files `array`	Массив файлов сообщения, если это поле было передано во входных данных

Объект chat

Название `тип`	Описание
id `string`	Идентификатор чата или канала во внешней системе, который передавали в `MESSAGES[].chat.id`
description `string`	Описание чата. Поле возвращается, если в `MESSAGES[].chat` передавали ссылку `url`

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

HTTP-статус: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'CONNECTOR' is null or empty"
        }

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

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

Статус	Код	Описание	Значение
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	Метод вызван не в контексте приложения OAuth
`400`	`ERROR_ARGUMENT`	Argument 'CONNECTOR' is null or empty	Не передан `CONNECTOR`
`400`	`ERROR_ARGUMENT`	Argument 'LINE' is null or empty	Не передан `LINE`
`400`	`ERROR_ARGUMENT`	Argument 'MESSAGES' is null or empty	Не передан `MESSAGES`
`400`	`NOT_ACTIVE_LINE`	Линия c таким ID неактивна или не существует	Передан неактивный `LINE`
`400`	`IMCONNECTOR_NO_CORRECT_PROVIDER`	Не удалось найти подходящий провайдер для коннектора	Для коннектора не удалось инициализировать провайдер

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

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

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

Изменить отправленные сообщения

Обновить статус «доставлено»

Удалить отправленные сообщения imconnector.delete.messages

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

Параметр MESSAGESПараметр MESSAGES

Объект userОбъект user

Объект messageОбъект message

Объект chatОбъект chat

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

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

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

Объект DATAОбъект DATA

Объект RESULT[]Объект RESULT[]

Объект messageОбъект message

Объект chatОбъект chat

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

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

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

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

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

Параметр MESSAGES

Объект user

Объект message

Объект chat

Примеры кода

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

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

Объект DATA

Объект RESULT[]

Объект message

Объект chat

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

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

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

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