метод REST
scope: im
im.dialog.get
Получить данные о чате
Описание
Метод im.dialog.get получает информацию о чате.
Параметры
DIALOG_ID
string
обязательный
Идентификатор чата в формате:
- chatXXX — чат
- sgXXX — чат группы или проекта
- XXX — идентификатор пользователя личного чата
Примеры: chat1435, sg103
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat1435"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat1435","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.dialog.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ImDialogGetResult = {
id: number
parent_chat_id: number
parent_message_id: number
name: string
description: string
owner: number
extranet: boolean
avatar: string
color: string
type: string
counter: number
user_counter: number
message_count: number
unread_id: number
restrictions: {
avatar: boolean
rename: boolean
extend: boolean
call: boolean
mute: boolean
leave: boolean
leave_owner: boolean
send: boolean
user_list: boolean
path: string
path_title: string
}
last_message_id: number
last_id: number
marked_id: number
disk_folder_id: number
entity_type: string
entity_id: string
entity_data_1: string
entity_data_2: string
entity_data_3: string
mute_list: number[]
date_create: ISODate
message_type: string
public: string
role: string
entity_link: {
type: string
url: string
id: string
}
text_field_enabled: boolean
background_id: number | null
permissions: {
manage_users_add: string
manage_users_delete: string
manage_ui: string
manage_settings: string
manage_messages: string
can_post: string
}
is_new: boolean
readed_list: {
user_id: number
user_name: string
message_id: number
date: ISODate | null
}[]
manager_list: number[]
last_message_views: {
message_id: number
first_viewers: number[]
count_of_viewers: number
}
dialog_id: string
}
try {
const response = await $b24.actions.v2.call.make<ImDialogGetResult>({
method: 'im.dialog.get',
params: {
DIALOG_ID: 'chat1435',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Dialog:', result.id, result.name, result.type, result.role)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getDialog() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.dialog.get',
params: {
DIALOG_ID: 'chat1435',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Dialog:', result.id, result.name, result.type, result.role)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDialog)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.dialog.get(
dialog_id="chat1435",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'im.dialog.get',
[
'DIALOG_ID' => 'chat1435',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'im.dialog.get',
{
DIALOG_ID: 'chat1435'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.dialog.get',
[
'DIALOG_ID' => 'chat1435',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.dialog.get", b24.Params{
"DIALOG_ID": "chat1435",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.dialog.get: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
ParentChatID int `json:"parent_chat_id"`
ParentMessageID int `json:"parent_message_id"`
Name string `json:"name"`
Description string `json:"description"`
Owner int `json:"owner"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.ParentChatID)
Ответ
HTTP-статус: 200
{
"result": {
"id": 1439,
"parent_chat_id": 0,
"parent_message_id": 0,
"name": "Чат по сделке",
"description": "Здесь обсуждаем сделку",
"owner": 503,
"extranet": false,
"avatar": "",
"color": "#f76187",
"type": "crm",
"counter": 0,
"user_counter": 3,
"message_count": 3,
"unread_id": 0,
"restrictions": {
"avatar": false,
"rename": false,
"extend": true,
"call": true,
"mute": true,
"leave": true,
"leave_owner": false,
"send": true,
"user_list": true,
"path": "",
"path_title": ""
},
"last_message_id": 84477,
"last_id": 84477,
"marked_id": 0,
"disk_folder_id": 0,
"entity_type": "CRM",
"entity_id": "DEAL|1663",
"entity_data_1": "",
"entity_data_2": "",
"entity_data_3": "",
"mute_list": [],
"date_create": "2026-02-25T16:50:58+03:00",
"message_type": "C",
"public": "",
"role": "owner",
"entity_link": {
"type": "DEAL",
"url": "/crm/deal/details/1663/",
"id": "DEAL|1663"
},
"text_field_enabled": true,
"background_id": null,
"permissions": {
"manage_users_add": "member",
"manage_users_delete": "manager",
"manage_ui": "member",
"manage_settings": "owner",
"manage_messages": "member",
"can_post": "member"
},
"is_new": false,
"readed_list": [
{
"user_id": 103,
"user_name": "Иван Иванов",
"message_id": 0,
"date": null
},
{
"user_id": 547,
"user_name": "Петр Петров",
"message_id": 0,
"date": null
}
],
"manager_list": [
503
],
"last_message_views": {
"message_id": 84477,
"first_viewers": [],
"count_of_viewers": 0
},
"dialog_id": "chat1439"
},
"time": {
"start": 1772030091,
"finish": 1772030091.165223,
"duration": 0.1652228832244873,
"processing": 0,
"date_start": "2026-02-25T17:34:51+03:00",
"date_finish": "2026-02-25T17:34:51+03:00",
"operating_reset_at": 1772030691,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой объект с данными чата (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
400 |
DIALOG_ID_EMPTY |
Dialog ID can't be empty |
403 |
ACCESS_ERROR |
You do not have access to the specified dialog |

