Get a List of Offline Events with `event.offline.get`

Who can execute the method: any user

The method event.offline.get returns the first queued offline events to the application according to the filter settings. The availability of offline events can be checked using the feature.get method.

This method works only in the context of application authorization.

Method Parameters

Required parameters are marked with *

Name `type`	Description
filter `array`	Record filter. By default, all records are returned without filtering. Filtering is supported by fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID` with standard operations like `=`, `>`, `<`, `<=`, and so on. Important: the operation type is placed before the field name in the filter
order `array`	Record sorting. Sorting is supported by the same fields as in the filter, and an array of the form `[field=>ASC	DESC]` is accepted. By default — [TIMESTAMP_X:ASC]
limit `integer`	Number of records to select. Default is 50

Additional Parameters

Name `type`	Description
clear `integer`	Values: `0	1`— whether to delete the selected records. Default is`1`
process_id `string`	Process identifier. Used if you need to re-select any unprocessed records from the current process
auth_connector `string`	Source key. Used if the `auth_connector` value was specified in the event.bind method
error `integer`	Values: `0	1`— whether to return erroneous records. Default is`0`

Note

The method supports multithreaded parsing. This means that multiple parallel requests to /rest/event.offline.get are allowed (subject to limits on the number of requests per unit of time), and each will receive different sets of records.

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 '{"filter":{"=MESSAGE_ID":1,"=EVENT_NAME":"ONCRMLEADADD",">=ID":1},"auth_connector":"BxTest","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/event.offline.get

try
        {
            const response = await $b24.callMethod(
                'event.offline.get',
                {
                    filter: {
                        '=MESSAGE_ID': 1,
                        '=EVENT_NAME': 'ONCRMLEADADD',
                        '>=ID': 1
                    },
                    auth_connector: 'BxTest'
                }
            );
            
            const result = response.getData().result;
            console.log('Result:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'event.offline.get',
                    [
                        'filter' => [
                            '=MESSAGE_ID' => 1,
                            '=EVENT_NAME' => 'ONCRMLEADADD',
                            '>=ID' => 1
                        ],
                        'auth_connector' => 'BxTest'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            "event.offline.get",
            {
                "filter": {
                    "=MESSAGE_ID": 1,
                    "=EVENT_NAME": "ONCRMLEADADD",
                    ">=ID": 1
                },
                "auth_connector": "BxTest"
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'event.offline.get',
            [
                'filter' => [
                    '=MESSAGE_ID' => 1,
                    '=EVENT_NAME' => 'ONCRMLEADADD',
                    '>=ID' => 1
                ],
                'auth_connector' => 'BxTest'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "process_id": null,
                "events": [
                    {
                        "ID": "1",
                        "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
                        "EVENT_NAME": "ONCRMLEADADD",
                        "EVENT_DATA": false,
                        "EVENT_ADDITIONAL": false,
                        "MESSAGE_ID": "1"
                    }
                ]
            },
            "time": {
                "start": 1721299720.388504,
                "finish": 1721299720.509809,
                "duration": 0.12130498886108398,
                "processing": 0.008239030838012695,
                "date_start": "2024-07-18T12:48:40+02:00",
                "date_finish": "2024-07-18T12:48:40+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
time `time`	Information about the execution time of the request

Error Handling

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

Get a List of Offline Events

Clear Offline Event Queues

Get a List of Offline Events with event.offline.get

Method ParametersMethod Parameters

Additional ParametersAdditional Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning