Delete Sent Messages imconnector.delete.messages

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

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Modify Sent Messages

Update Delivery Status

Delete Sent Messages imconnector.delete.messages

Method ParametersMethod Parameters

MESSAGES ParameterMESSAGES Parameter

User ObjectUser Object

Message ObjectMessage Object

Chat ObjectChat Object

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

DATA ObjectDATA Object

RESULT[] ObjectRESULT[] Object

Message ObjectMessage Object

Chat ObjectChat Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

MESSAGES Parameter

User Object

Message Object

Chat Object

Code Examples

Response Handling

Returned Data

DATA Object

RESULT[] Object

Message Object

Chat Object

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning