Chat Fields

Chat data that can be retrieved using the method imbot.dialog.get.

Name
type

Description

id
integer

Chat identifier

parent_chat_id
integer

Parent chat identifier

parent_message_id
integer

Parent message identifier

name
string

Chat name

description
string

Chat description

owner
integer

Chat owner identifier

extranet
boolean

Extranet chat flag

avatar
string

Chat avatar URL

color
string

Chat color in HEX format

type
string

Chat type

counter
integer

Message counter

user_counter
integer

User counter

message_count
integer

Number of messages in the chat

unread_id
integer

Identifier of the first unread message

restrictions
object

Object with description of restrictions

last_message_id
integer

Identifier of the last message

last_id
integer

Identifier of the last message

marked_id
integer

Identifier of the marked message

disk_folder_id
integer

Identifier of the folder on Drive

entity_type
string

Type of the related object

entity_id
string

Identifier of the related object

entity_data_1
string

Additional data of the object

entity_data_2
string

Additional data of the object

entity_data_3
string

Additional data of the object

mute_list
array

List of users with notifications turned off

date_create
string

Creation date in ISO 8601 format

message_type
string

Type of chat messages

public
string

Public identifier of the chat

role
string

Role of the current user in the chat

entity_link
object

Object with link to the entity

text_field_enabled
boolean

Is text input allowed

background_id
integer

Identifier of the chat background

permissions
object

Object with chat permissions

is_new
boolean

New chat flag

readed_list
array

List of users who read the message

manager_list
array

List of chat manager identifiers

last_message_views
object

Information about views of the last message

dialog_id
string

Dialog identifier

Restrictions Object

Name
type

Description

avatar
boolean

Can change avatar

rename
boolean

Can rename chat

extend
boolean

Can add participants

call
boolean

Can make calls

mute
boolean

Can turn off notifications

leave
boolean

Can leave the chat

leave_owner
boolean

Can the owner leave the chat

send
boolean

Can send messages

user_list
boolean

Can get the list of participants

Name
type

Description

type
string

Type of the related object

url
string

Link to the related object

id
string

Identifier of the related object

Permissions Object

Name
type

Description

manage_users_add
string

Minimum role for adding users

manage_users_delete
string

Minimum role for deleting users

manage_ui
string

Minimum role for managing the interface

manage_settings
string

Minimum role for managing settings

manage_messages
string

Minimum role for managing messages

can_post
string

Minimum role for sending messages

Readed List Item Object

Name
type

Description

user_id
integer

User identifier

user_name
string

User name

message_id
integer

Identifier of the last read message

date
string

Read date in ISO 8601 format

Last Message Views Object

Name
type

Description

message_id
integer

Message identifier

first_viewers
array

List of first viewers

count_of_viewers
integer

Number of views

Last Message Views First Viewers Item Object

Name
type

Description

user_id
integer

User identifier

user_name
string

User name

date
string

View date in ISO 8601 format