Get Information About the Chat imbot.v2.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: owner of the registered bot

The method imbot.v2.Chat.get returns information about the chat. The bot must be a participant in the chat.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId* `integer`	Bot ID
botToken `string`	Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during the registration of the chatbot
dialogId* `string`	Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"dialogId":"chat5","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.get

try {
          const response = await $b24.callMethod('imbot.v2.Chat.get', {
            botId: 456,
            dialogId: 'chat5',
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imbot.v2.chat.get(
                bot_id=456,
                dialog_id="chat5",
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Chat.get',
                    [
                        'botId' => 456,
                        'dialogId' => 'chat5',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }

BX24.callMethod(
            'imbot.v2.Chat.get',
            {
                botId: 456,
                dialogId: 'chat5',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Chat.get',
            [
                'botId' => 456,
                'dialogId' => 'chat5',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Chat name: '. $result['result']['chat']['name'];
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.v2.Chat.get", b24.Params{
        	"botId":    456,
        	"botToken": "my_bot_token",
        	"dialogId": "chat5",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imbot.v2.Chat.get: %w", err)
        }
        
        // The method wraps the response in an object with the "chat" key.
        raw, ok := b24.Unwrap(res.Result, "chat")
        if !ok {
        	return fmt.Errorf("no chat key in the response")
        }
        
        var item struct {
        	ID          b24.ID `json:"id"`
        	DialogID    string `json:"dialogId"`
        	Name        string `json:"name"`
        	Description string `json:"description"`
        	Type        string `json:"type"`
        	MessageType string `json:"messageType"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.DialogID)

Response Handling

HTTP Status: 200

{
            "result": {
                "chat": {
                    "id": 5,
                    "dialogId": "chat5",
                    "name": "Support Chat",
                    "description": "",
                    "type": "chat",
                    "messageType": "C",
                    "owner": 456,
                    "color": "#4ba984",
                    "avatar": "",
                    "extranet": false,
                    "containsCollaber": false,
                    "entityType": "",
                    "entityId": "",
                    "entityData1": "",
                    "entityData2": "",
                    "entityData3": "",
                    "entityLink": {},
                    "diskFolderId": 42,
                    "role": "owner",
                    "permissions": {},
                    "muteList": [],
                    "parentChatId": null,
                    "parentMessageId": null,
                    "isNew": false,
                    "textFieldEnabled": "Y",
                    "backgroundId": null,
                    "dateCreate": "2025-01-15T10:00:00+01:00",
                    "lastMessageId": 789,
                    "lastMessageViews": "{}",
                    "lastId": 789,
                    "managerList": [],
                    "markedId": null,
                    "messageCount": 15,
                    "public": "",
                    "unreadId": null,
                    "userCounter": 3
                }
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+01:00",
                "date_finish": "2024-10-11T10:00:00+01:00"
            }
        }

Returned Data

Name `Type`	Description
result `object`	Result of the request
result.chat `Chat`	Chat object (detailed description)
time `time`	Information about the request execution time

Chat Object Fields

Field `Type`	Description
id `integer`	Unique identifier of the chat
dialogId `string`	Dialog identifier: `chat5` for group chats, `123` for personal chats
name `string`	Name of the chat
description `string`	Description of the chat
type `string`	Type of chat: `chat`, `open`, `channel`, and others
owner `integer`	ID of the chat owner
color `string\|null`	Color of the chat in HEX format
avatar `string`	URL of the chat avatar. Empty string if not set
role `string`	Role of the current user: `owner`, `manager`, `member`, `guest`, `none`
dateCreate `string\|null`	Creation date of the chat in ISO 8601 format
lastMessageId `integer\|null`	ID of the last message
muteList `array`	List of user IDs who have disabled notifications
managerList `array`	Array of chat manager IDs

Full description of all fields can be found on the page Objects and Fields — Chat.

Error Handling

HTTP Status: 400, 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied"
        }

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
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` not specified. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` not specified
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Bot registered by another application
`ACCESS_DENIED`	Access denied	Bot is not a participant in the 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?

Create Group Chat

Update Chat Properties

Get Information About the Chat imbot.v2.Chat.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Chat Object FieldsChat Object Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning