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

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

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

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 -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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type DeleteMessagesResult = {
  SUCCESS: boolean
  DATA: {
    RESULT: Array<{
      user: string
      message: { id: string; date?: number; text?: string; files?: unknown[] }
      chat: { id: string; description?: string }
      SUCCESS: boolean
      ERRORS?: string[]
    }>
  }
}

try {
  const response = await $b24.actions.v2.call.make<DeleteMessagesResult>({
    method: 'imconnector.delete.messages',
    params: {
      CONNECTOR: 'myconnector',
      LINE: 107,
      MESSAGES: [
        {
          user: { id: 'ext-user-42' },
          message: { id: 'ext-msg-1001' },
          chat: { id: 'channel-123' },
        },
      ],
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.SUCCESS, result.DATA.RESULT)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function deleteMessages() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imconnector.delete.messages',
        params: {
          CONNECTOR: 'myconnector',
          LINE: 107,
          MESSAGES: [
            {
              user: { id: 'ext-user-42' },
              message: { id: 'ext-msg-1001' },
              chat: { id: 'channel-123' },
            },
          ],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.SUCCESS, result.DATA.RESULT)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', deleteMessages)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imconnector.delete.messages(
        connector="myconnector",
        line=107,
        messages=[
            {
                "user": {
                    "id": "ext-user-42",
                },
                "message": {
                    "id": "ext-msg-1001",
                },
                "chat": {
                    "id": "channel-123",
                },
            },
        ],
    ).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}")

$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'],
            ],
        ],
    ]
);

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.delete.messages", b24.Params{
	"CONNECTOR": "myconnector",
	"LINE":      107,
	"MESSAGES": []b24.Params{
		{
			"user": b24.Params{
				"id": "ext-user-42",
			},
			"message": b24.Params{
				"id": "ext-msg-1001",
			},
			"chat": b24.Params{
				"id": "channel-123",
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("imconnector.delete.messages: %w", err)
}

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

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

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
string

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

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

Статус

Код

Описание

Значение

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-статус: 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

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

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

Предыдущая
Изменить отправленные сообщения
Следующая
Обновить статус «доставлено»