Update Status "Delivered" imconnector.send.status.delivery

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.send.status.delivery confirms in Bitrix24 that an outgoing message from an open line has been successfully delivered to an external system. This method does not resend the message; it only records the delivery result.

In the current implementation of open lines, when processing the "delivered" status, the message is also marked as "read."

The method is not applicable for incoming messages from an external system to an open line.

The method works only in the context of the application.

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 methods imopenlines.config.get and imopenlines.config.list.get

MESSAGES*
array

Array of delivery statuses. Each element of the array is an object with blocks im, message, chat.

The structure of the object is described in detail below

MESSAGES Parameter

Name
type

Description

im
object

Internal identifiers of the message in Bitrix24 (detailed description)

message
object

Message data in the external system (detailed description)

chat
object

Chat data in the external system (detailed description)

im Object

Name
type

Description

chat_id
integer

Identifier of the open line chat in Bitrix24 for the outgoing message

message_id
integer

Identifier of the message in Bitrix24 for which the delivery status needs to be set

The fields im.chat_id and im.message_id should be obtained from the event OnImConnectorMessageAdd when Bitrix24 sends a message to the external system.

Typically, these values are saved when processing the event and then used to send the delivery status.

The external identifiers message.id and chat.id do not replace im.message_id and im.chat_id.

message Object

Name
type

Description

id
array

Array of external message identifiers for which the delivery status is being sent. Even for a single message, pass an array, e.g., ["ext-msg-1007"]

date
integer

Delivery time of the message in Unix Timestamp in seconds

chat Object

Name
type

Description

id
string

Identifier of the chat or channel in the external system. It is recommended to pass the same value as in chat.id of the method imconnector.send.messages

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": [
              {
                "im": {
                  "chat_id": 323,
                  "message_id": 85911
                },
                "message": {
                  "id": ["ext-msg-1007"],
                  "date": 1738065600
                },
                "chat": {
                  "id": "channel-123"
                }
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.send.status.delivery
        
// 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 SendStatusDeliveryResult = {
          SUCCESS: boolean
          DATA: unknown[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<SendStatusDeliveryResult>({
            method: 'imconnector.send.status.delivery',
            params: {
              CONNECTOR: 'myconnector',
              LINE: 107,
              MESSAGES: [
                {
                  im: { chat_id: 323, message_id: 85911 },
                  message: { id: ['ext-msg-1007'], date: 1738065600 },
                  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('Delivery status accepted:', result.SUCCESS, 'data:', result.DATA)
          }
        } 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 sendStatusDelivery() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imconnector.send.status.delivery',
                params: {
                  CONNECTOR: 'myconnector',
                  LINE: 107,
                  MESSAGES: [
                    {
                      im: { chat_id: 323, message_id: 85911 },
                      message: { id: ['ext-msg-1007'], date: 1738065600 },
                      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('Delivery status accepted:', result.SUCCESS, 'data:', result.DATA)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendStatusDelivery)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imconnector.send.status.delivery(
                connector="myconnector",
                line=107,
                messages=[
                    {
                        "im": {
                            "chat_id": 323,
                            "message_id": 85911,
                        },
                        "message": {
                            "id": [
                                "ext-msg-1007",
                            ],
                            "date": 1738065600,
                        },
                        "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.send.status.delivery',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'im' => ['chat_id' => 323, 'message_id' => 85911],
                        'message' => ['id' => ['ext-msg-1007'], 'date' => 1738065600],
                        'chat' => ['id' => 'channel-123'],
                    ],
                ],
            ]
        );
        
BX24.callMethod(
          'imconnector.send.status.delivery',
          {
            CONNECTOR: 'myconnector',
            LINE: 107,
            MESSAGES: [
              {
                im: { chat_id: 323, message_id: 85911 },
                message: { id: ['ext-msg-1007'], date: 1738065600 },
                chat: { id: 'channel-123' },
              },
            ],
          },
          function(result) {
            console.log(result.data());
          }
        );
        
$result = CRest::call(
            'imconnector.send.status.delivery',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'im' => ['chat_id' => 323, 'message_id' => 85911],
                        'message' => ['id' => ['ext-msg-1007'], 'date' => 1738065600],
                        'chat' => ['id' => 'channel-123'],
                    ],
                ],
            ]
        );
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imconnector.send.status.delivery", b24.Params{
        	"CONNECTOR": "myconnector",
        	"LINE":      107,
        	"MESSAGES": []b24.Params{
        		{
        			"im": b24.Params{
        				"chat_id":    323,
        				"message_id": 85911,
        			},
        			"message": b24.Params{
        				"id":   []string{"ext-msg-1007"},
        				"date": 1738065600,
        			},
        			"chat": b24.Params{
        				"id": "channel-123",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("imconnector.send.status.delivery: %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": []
            },
            "time": {
            "start": 1738065600.11,
            "finish": 1738065600.21,
            "duration": 0.10,
            "processing": 0.04,
            "date_start": "2025-01-28T12:00:00+00:00",
            "date_finish": "2025-01-28T12:00:00+00:00"
            }
        }
        

Returned Data

Name
type

Description

SUCCESS
boolean

Returns true if the delivery status was successfully accepted and updated in Bitrix24

DATA
array

Empty array upon successful processing

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }
        

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 not in the context of the OAuth application

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

IMCONNECTOR_NO_CORRECT_PROVIDER

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