Get Chat ID im.chat.get

Scope: im

Who can execute the method: any user

The method im.chat.get retrieves the chat ID.

Method Parameters

Required parameters are marked with *

Name
type

Description

ENTITY_TYPE*
string

The type of object for linking the chat to an external context. Passed as a string.

Possible values:

VIDEOCONF — video conference chat
AI_ASSISTANT_PRIVATE — private chat with an AI assistant
LINES — open line chat from the operator's side
LIVECHAT — open line chat from the client's side
ANNOUNCEMENT — announcement chat
CALENDAR — chat related to a calendar event
MAIL — chat related to email correspondence
CRM — system chat "for discussion" of a CRM entity. The method will not return IDs of other chats related to the CRM entity
SONET_GROUP — social network group chat
TASKS_TASK — task chat in the new task card
TASKS — system task chat in the old task card
CALL — chat related to a call

ENTITY_ID*
string

Identifier of the object within ENTITY_TYPE.

Passed as a string. The format depends on the selected ENTITY_TYPE.

Supported formats for common types:

CRM — <CRM_TYPE>|<ID>, for example LEAD|13, DEAL|1663, CONTACT|25, COMPANY|7. For smart processes — DYNAMIC_<entityTypeId>|<itemId>
LINES — <connectorId>|<lineId>|<connectorChatId>|<connectorUserId>, for example telegrambot|2|209607941|744
LIVECHAT — <connectorId>|<lineId>
TASKS, TASKS_TASK — task identifier, for example 8293
CALENDAR — calendar event identifier
SONET_GROUP — group identifier

For other ENTITY_TYPE, the format is defined by the module or integration. It can be an arbitrary string.

When creating a chat, you can pass an arbitrary pair of ENTITY_TYPE and ENTITY_ID. The method im.chat.get will return the chat if called with the same pair of values

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 '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.chat.get

try
        {
            const response = await $b24.callMethod(
                'im.chat.get',
                {
                    ENTITY_TYPE: 'CRM',
                    ENTITY_ID: 'DEAL|1663'
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.chat.get',
                    [
                        'ENTITY_TYPE' => 'CRM',
                        'ENTITY_ID' => 'DEAL|1663',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'CHAT_ID: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.chat.get',
            {
                ENTITY_TYPE: 'CRM',
                ENTITY_ID: 'DEAL|1663',
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.chat.get',
            [
                'ENTITY_TYPE' => 'CRM',
                'ENTITY_ID' => 'DEAL|1663',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": 1437
            },
            "time": {
                "start": 1772028217,
                "finish": 1772028217.949613,
                "duration": 0.949613094329834,
                "processing": 0,
                "date_start": "2026-02-25T17:03:37+01:00",
                "date_finish": "2026-02-25T17:03:37+01:00",
                "operating_reset_at": 1772028817,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Returns an object with the chat ID ID.

The method will return null:

if the chat is not found
if required parameters are not specified
if parameters are filled incorrectly

time
time

Information about the execution time of the request

Error Handling

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

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

Create Chat

Get Chat Data

Get Chat ID im.chat.get

Method ParametersMethod 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