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

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 (OAuth)

PHP

BX24.js

PHP CRest

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

const payload = {
          CONNECTOR: 'myconnector',
          LINE: 107,
          MESSAGES: [
            {
              im: { chat_id: 323, message_id: 85911 },
              message: { id: ['ext-msg-1007'], date: 1738065600 },
              chat: { id: 'channel-123' },
            },
          ],
        };
        
        const response = await $b24.callMethod('imconnector.send.status.delivery', payload);
        console.log(response.getData());

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

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

Delete Sent Messages

Set New Chat Name

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

Method ParametersMethod Parameters

MESSAGES ParameterMESSAGES Parameter

im Objectim Object

message Objectmessage Object

chat Objectchat Object

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning