Delete Sent Messages imconnector.delete.messages

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: imopenlines

Who can execute the method: any user

The method imconnector.delete.messages removes messages from an open line that were sent by an external system.

The method works only in the context of an application.

The method parameters use values from the external system: user ID, message ID, and chat or channel ID.

To delete messages, provide message.id and chat.id that were used when sending messages via the imconnector.send.messages method.

Method Parameters

Required parameters are marked with *

Name
type

Description

CONNECTOR*
string

String code of the connector specified in the ID parameter when calling imconnector.register

LINE*
integer

Identifier of the open line.

The identifier can be obtained using the imopenlines.config.get and imopenlines.config.list.get methods

MESSAGES*
array

Array of messages to delete. Each element of the array is a message object with three required blocks: user, message, chat. The structure of the object is described in detail below

MESSAGES Parameter

Name
type

Description

user
object

User data from the external system.

The structure of the object is described in detail below

message
object

Message data from the external system.

The structure of the object is described in detail below

chat
object

Chat or channel data from the external system.

The structure of the object is described in detail below

User Object

Name
type

Description

id*
string

User ID in the external system.

It is recommended to provide the same value used in user.id of the imconnector.send.messages method

Message Object

Name
type

Description

id*
string

Message ID in the external system that needs to be deleted.

It is recommended to provide the same value used in message.id of the imconnector.send.messages method

Chat Object

Name
type

Description

id*
string

Chat or channel ID in the external system.

It is recommended to provide the same value as in chat.id of the imconnector.send.messages method

Code Examples

How to Use Examples in Documentation

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println(item.Success)
        

Response Handling

HTTP Status: 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+01:00",
                "date_finish": "2026-03-11T14:19:25+01:00",
                "operating_reset_at": 1773268164,
                "operating": 0.113616943359375
            }
        }
        

Returned Data

Name
type

Description

SUCCESS
boolean

Returns true if the message deletion was successful

DATA
object

Data regarding the message processing.

The structure of the object is described in detail below

time
time

Information about the request execution time

DATA Object

Name
type

Description

RESULT
array

Array of results for each element of MESSAGES

The structure of each element is described in detail below

RESULT[] Object

Name
type

Description

user
string

Internal user ID in Bitrix24

message
object

Data of the deleted message (detailed description)

chat
object

Data of the chat or channel (detailed description)

SUCCESS
boolean

Indicator of successful processing of the current array element

ERRORS
array

Array of error texts for the current element, returned when SUCCESS = false

Message Object

Name
type

Description

id
string

Message ID in the external system that was passed in MESSAGES[].message.id

date
integer

Message time in Unix Timestamp, if this field was provided in the input data

text
string

Text of the message, if this field was provided in the input data

files
array

Array of message files, if this field was provided in the input data

Chat Object

Name
type

Description

id
string

Chat or channel ID in the external system that was passed in MESSAGES[].chat.id

description
string

Description of the chat. This field is returned if a url link was provided in MESSAGES[].chat

Error Handling

HTTP Status: 400, 403

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Method called outside of the application context OAuth

400

ERROR_ARGUMENT

Argument 'CONNECTOR' is null or empty

CONNECTOR not provided

400

ERROR_ARGUMENT

Argument 'LINE' is null or empty

LINE not provided

400

ERROR_ARGUMENT

Argument 'MESSAGES' is null or empty

MESSAGES not provided

400

NOT_ACTIVE_LINE

Line with such ID is inactive or does not exist

Inactive LINE provided

400

IMCONNECTOR_NO_CORRECT_PROVIDER

Could not find a suitable provider for the connector

Failed to initialize provider for the connector

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning