Get Chat ID imbot.chat.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imbot

Who can execute the method: user with access to the chat

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Chat.get.

The method imbot.chat.get returns the chat ID.

To obtain detailed information about the chat, use the method imbot.dialog.get.

Method Parameters

Required parameters are marked with *

Name
type

Description

ENTITY_TYPE*
string

Type of the external object.

Used together with ENTITY_ID, which was passed when creating the chat using the method imbot.chat.add

ENTITY_ID*
string

Identifier of the external object.

Used together with ENTITY_TYPE, which was passed when creating the chat using the method imbot.chat.add

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":"CHAT","ENTITY_ID":"13"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.get

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"ENTITY_TYPE":"CHAT","ENTITY_ID":"13","auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.chat.get

try
        {
            const response = await $b24.callMethod(
                'imbot.chat.get',
                {
                    ENTITY_TYPE: 'CHAT',
                    ENTITY_ID: '13'
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved chat data:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.chat.get',
                    [
                        'ENTITY_TYPE' => 'CHAT',
                        'ENTITY_ID' => '13'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving chat: ' . $e->getMessage();
        }

BX24.callMethod(
            'imbot.chat.get',
            {
                ENTITY_TYPE: 'CHAT',
                ENTITY_ID: '13'
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.chat.get',
            [
                'ENTITY_TYPE' => 'CHAT',
                'ENTITY_ID' => '13'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.chat.get", b24.Params{
        	"ENTITY_TYPE": "CHAT",
        	"ENTITY_ID":   "13",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imbot.chat.get: %w", err)
        }
        
        var item struct {
        	ID b24.ID `json:"ID"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID)

Response Handling

HTTP Status: 200

{
          "result": {
              "ID": 2725
          },
          "time": {
              "start": 1771929873,
              "finish": 1771929873.459722,
              "duration": 0.45972204208374023,
              "processing": 0,
              "date_start": "2026-02-24T13:44:33+01:00",
              "date_finish": "2026-02-24T13:44:33+01:00",
              "operating_reset_at": 1771930473,
              "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Chat identifier.

Returns null if either ENTITY_TYPE or ENTITY_ID parameter is not provided

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "ACCESS_ERROR",
            "error_description": "You don't have access to this chat"
        }

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

Code	Description	Value
`AUTHORIZE_ERROR`	Method not available for guest session.	Method is not available in guest session
`ACCESS_ERROR`	You don't have access to this chat	No access to the specified chat

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	The REST API is available only on commercial plans. 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

Was the article helpful?

Change Chat Color

Retrieve Chat Data

Get Chat ID imbot.chat.get

Method ParametersMethod Parameters

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