Get Chats for CRM Object imopenlines.crm.chat.get

Scope: imopenlines

Who can execute the method: any user with access to the CRM object

The method imopenlines.crm.chat.get retrieves a list of chats associated with a CRM object.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CRM_ENTITY_TYPE* `string`	Type of the CRM object. Possible values: `lead` — lead `deal` — deal `company` — company `contact` — contact
CRM_ENTITY* `integer`	Identifier of the CRM object. You can obtain the identifier using the universal method to get a list of CRM entities
ACTIVE_ONLY `char`	Flag to return only active chats. Possible values: `Y` — return only active chats `N` — return all chats Default is `Y`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"ACTIVE_ONLY":"N"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.chat.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"ACTIVE_ONLY":"N","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.get

try
        {
            const response = await $b24.callMethod(
                'imopenlines.crm.chat.get',
                {
                    CRM_ENTITY_TYPE: 'lead',
                    CRM_ENTITY: 1205,
                    ACTIVE_ONLY: 'N'
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.crm.chat.get',
                    [
                        'CRM_ENTITY_TYPE' => 'lead',
                        'CRM_ENTITY' => 1205,
                        'ACTIVE_ONLY' => 'N',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'imopenlines.crm.chat.get',
            {
                CRM_ENTITY_TYPE: 'lead',
                CRM_ENTITY: 1205,
                ACTIVE_ONLY: 'N'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.crm.chat.get',
            [
                'CRM_ENTITY_TYPE' => 'lead',
                'CRM_ENTITY' => 1205,
                'ACTIVE_ONLY' => 'N',
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "CHAT_ID": "1763",
                    "CONNECTOR_ID": "livechat",
                    "CONNECTOR_TITLE": "Live Chat"
                }
            ],
            "time": {
                "start": 1773758908,
                "finish": 1773758908.592458,
                "duration": 0.5924580097198486,
                "processing": 0,
                "date_start": "2026-03-17T17:48:28+01:00",
                "date_finish": "2026-03-17T17:48:28+01:00",
                "operating_reset_at": 1773759508,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

List of chat objects (detailed description).

Returns an empty array "result":[] if no object with the specified CRM_ENTITY exists

time
time

Information about the request execution time

Result Object

Name `type`	Description
CHAT_ID `string`	Identifier of the chat
CONNECTOR_ID `string`	Identifier of the connector
CONNECTOR_TITLE `string`	Title of the connector

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument CRM_ENTITY 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`	`ACCESS_DENIED`	Access denied! You don't have access to this action	User does not have access to the CRM object
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY_TYPE is null or empty	Required parameter `CRM_ENTITY_TYPE` is not provided or is empty
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY is null or empty	Required parameter `CRM_ENTITY` is not provided or is empty
`400`	`ERROR_ARGUMENT`	The value of an argument CRM_ENTITY has an invalid type	Parameter `CRM_ENTITY` is provided in an incorrect format

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 the ID of the Last CRM Object Chat

Add a User to an Existing CRM Object Chat

Get Chats for CRM Object imopenlines.crm.chat.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning