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

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to 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 a chat the bot is a participant of. The method returns the data of an open chat or an open channel even if the bot is not a participant.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId* `integer`	Bot ID
botToken `string`	Bot token. Required for webhook authorization, not needed for OAuth. Pass the same `botToken` that you specified when registering the bot
dialogId* `string`	Dialog ID in the dialogId format: `chat{chatId}` for a group chat, `{userId}` for a personal chat

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": {
                        "type": "",
                        "url": "",
                        "id": ""
                    },
                    "diskFolderId": null,
                    "role": "owner",
                    "permissions": {
                        "manageUsersAdd": "member",
                        "manageUsersDelete": "manager",
                        "manageUi": "member",
                        "manageSettings": "owner",
                        "manageMessages": "member",
                        "manageMessagesAutoDelete": "manager",
                        "manageGuestInvites": "manager",
                        "manageDelete": "member",
                        "canPost": "member"
                    },
                    "hasManageCapability": false,
                    "canHaveThreads": true,
                    "muteList": [],
                    "parentChatId": null,
                    "parentMessageId": null,
                    "isNew": false,
                    "textFieldEnabled": true,
                    "backgroundId": null,
                    "dateCreate": "2025-01-15T10:00:00+01:00",
                    "lastMessageId": 789,
                    "lastMessageViews": {
                        "messageId": 789,
                        "firstViewers": [],
                        "countOfViewers": 0
                    },
                    "lastId": 789,
                    "managerList": [456],
                    "markedId": 0,
                    "messageCount": 15,
                    "public": "",
                    "unreadId": 0,
                    "userCounter": 3,
                    "guestCount": 0
                },
                "users": [
                    {
                        "id": 456,
                        "active": true,
                        "name": "Support Bot",
                        "firstName": "Support Bot",
                        "lastName": "",
                        "workPosition": "",
                        "color": "#4ba984",
                        "avatar": "",
                        "gender": "M",
                        "birthday": "",
                        "extranet": false,
                        "bot": true,
                        "connector": false,
                        "externalAuthId": "bot",
                        "status": "online",
                        "idle": false,
                        "lastActivityDate": false,
                        "mobileLastDate": false,
                        "desktopLastDate": false,
                        "absent": false,
                        "departments": [],
                        "phones": false,
                        "type": "bot",
                        "website": "",
                        "email": ""
                    }
                ]
            },
            "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)
result.users `User[]`	An array with a single element — the data of the bot on whose behalf the request was made. Chat participants are returned by imbot.v2.Chat.User.list. Field descriptions — User
time `time`	Information about the request execution time

In addition to chat and users, the response contains service keys of the messenger interface: recentConfig, parentChat, copilot, messagesAutoDeleteConfigs, and callInfo. A bot does not need them, so they are omitted from the response example.

Chat Object Fields

Name `Type`	Description
id `integer`	Chat identifier
dialogId `string`	Dialog identifier. For a group chat — `chat{id}`, for example `chat5`
name `string`	Name of the chat
description `string`	Chat description. An empty string if not set
type `string`	Type of chat: `chat`, `open`, `channel`, `openChannel`, `copilot`, and others — list of values
messageType `string`	Internal single-letter chat type, for example `C` for a group chat and `O` for an open chat
owner `integer`	ID of the chat owner
color `string`	Chat color in HEX format
avatar `string`	URL of the chat avatar. An empty string if not set
extranet `boolean`	Whether the chat has extranet users
containsCollaber `boolean`	Whether the chat has collabers
entityType `string`	Type of the linked object, for example `LINES` for Open Channels. An empty string if the chat is not linked to an object
entityId `string`	Identifier of the linked object
entityData1 `string`	Additional data of the linked object, field 1
entityData2 `string`	Additional data of the linked object, field 2
entityData3 `string`	Additional data of the linked object, field 3
entityLink `object`	Link to the linked object — an object with the keys `type`, `url`, and `id`. If the chat is not linked to an object, the values are empty
diskFolderId `integer\|null`	ID of the Drive folder that stores the chat files
role `string`	Role of the bot in the chat: `owner`, `manager`, `member`, or `guest`. A bot that is not a participant of an open chat has the `guest` role
permissions `object`	Minimum role for actions in the chat. Keys: `manageUsersAdd`, `manageUsersDelete`, `manageUi`, `manageSettings`, `manageMessages`, `manageMessagesAutoDelete`, `manageGuestInvites`, `manageDelete`, `canPost`. Values: `member`, `manager`, `owner`, or `none` — the action is unavailable to everyone
canHaveThreads `boolean`	Whether threads can be created in the chat
hasManageCapability `boolean`	Service flag of extended access to chat management
muteList `integer[]`	Contains the bot ID if the bot has turned off notifications in the chat, otherwise an empty array
parentChatId `integer\|null`	ID of the parent chat if this is a thread
parentMessageId `integer\|null`	ID of the parent message if this is a thread
isNew `boolean`	`true` for an open channel created less than 24 hours ago. `false` for all other chats
textFieldEnabled `boolean`	Whether the message input field is enabled
backgroundId `string\|null`	Chat background ID
dateCreate `string\|null`	Creation date of the chat in ISO 8601 format
lastMessageId `integer\|null`	ID of the last message
lastMessageViews `object`	Views of the last message: `messageId` — message ID, `firstViewers` — the first viewers, `countOfViewers` — the number of viewers
lastId `integer`	ID of the last message read by the bot
managerList `integer[]`	IDs of the chat managers
markedId `integer`	ID of the message the bot marked as unread. `0` if there is no mark
messageCount `integer`	Number of messages in the chat
public `string\|object`	Public link to the chat — an object with the fields `code` and `link`. An empty string if there is no link
unreadId `integer`	ID of the first message unread by the bot. `0` if there are no unread messages
userCounter `integer`	Number of chat participants
guestCount `integer`	Number of guests in the chat

Which of these fields are included in event data is described on the page Objects and Fields — Chat.

Error Handling

HTTP Status: 400

{
            "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 not specified (botToken is required for webhook auth)	`botToken` is not specified. Required for webhook authorization
`BOT_ID_REQUIRED`	botId is required	`botId` is not specified
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot was installed by another rest application	The bot is registered by another application
`CHAT_NOT_FOUND`	CHAT_NOT_FOUND	No chat found with the specified `dialogId`
`ACCESS_DENIED`	ACCESS_DENIED	The bot is not a participant of a private 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	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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?

Update Chat Properties

Assign Chat Owner

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