Skip to main content

Get dialog

Get chat data by ID

Function GetDialog(Val URL, Val ChatID, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
ChatID--chatString, Number✔Chat ID (as chatXXX) or User ID (as XXX)
Token--tokenString✖Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

Method at API documentation: im.dialog.get


1C:Enterprise/OneScript code example
    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
    ChatID = "3060";

    OPI_TypeConversion.GetLine(ChatID);

    ChatString = "chat" + ChatID;

    Result = OPI_Bitrix24.GetDialog(URL, ChatString);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "75d8c668006e9f06006b12e400000001000...";
    UserID = 10;

    Result = OPI_Bitrix24.GetDialog(URL, UserID, Token);
    oint bitrix24 GetDialog \
     --url ""b24-ar17wx.bitrix24.by"" \
     --chat "10" \
     --token "***"
Result
{
 "result": {
  "id": 10,
  "parent_chat_id": 0,
  "parent_message_id": 0,
  "name": "",
  "description": null,
  "owner": 10,
  "extranet": false,
  "avatar": "",
  "color": "#ab7761",
  "type": "private",
  "counter": 0,
  "user_counter": 0,
  "message_count": 667,
  "unread_id": 0,
  "restrictions": {
   "avatar": true,
   "rename": true,
   "extend": true,
   "call": true,
   "mute": true,
   "leave": true,
   "leave_owner": true,
   "send": true,
   "user_list": true
  },
  "last_message_id": 61012,
  "last_id": 3854,
  "marked_id": 0,
  "disk_folder_id": 0,
  "entity_type": "",
  "entity_id": "",
  "entity_data_1": "",
  "entity_data_2": "",
  "entity_data_3": "",
  "mute_list": [],
  "date_create": "2024-06-15T16:48:49+00:00",
  "message_type": "P",
  "public": "",
  "role": "member",
  "entity_link": {
   "type": "",
   "url": ""
  },
  "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": 10,
    "user_name": "Techno Pizza",
    "message_id": 3854,
    "date": null
   }
  ],
  "manager_list": [],
  "last_message_views": {
   "message_id": 61012,
   "first_viewers": [],
   "count_of_viewers": 0
  },
  "dialog_id": "10"
 },
 "time": {
  "start": 1757976838.00959,
  "finish": 1757976838.04894,
  "duration": 0.0393519401550293,
  "processing": 0.0154221057891846,
  "date_start": "2025-09-15T22:53:58+00:00",
  "date_finish": "2025-09-15T22:53:58+00:00",
  "operating_reset_at": 1757977438,
  "operating": 0
 }
}