| Property name | Type | Description |
|---|---|---|
| _id | string | ID of the dialog. Generated automatically by the server after dialog creation. |
| user_id | int | ID of dialog’s owner. |
| created_at | datetime | Date & time when a record was created, filled automatically. |
| updated_at | datetime | Date & time when a record was updated, filled automatically. |
| type | int | Type of dialog. Possible values are:type=1 (PUBLIC_GROUP)type=2 (GROUP)type=3 (PRIVATE) |
| name | string | Name of a group chat. Makes sense if type=1 (PUBLIC_GROUP) or type=2 (GROUP). The maximum length for the dialog name is 200 symbols. |
| photo | string | Photo of a group chat. Makes sense if type=1 (PUBLIC_GROUP) or type=2 (GROUP). Can contain a link to a file in Content module, Custom Objects module or just a web link. |
| xmpp_room_jid | string | JID of XMPP room for group chat to connect. Null if type=3 (PRIVATE). Generated automatically by the server after dialog creation. |
| occupants_ids[] | array of int | Array of users’ IDs - dialog occupants. Empty array when type=1 (PUBLIC_GROUP) because public dialogs available for everyone. |
| admin_ids[] | array of int | Array of users’ IDs - dialog admins. Applicable only to type=1 (PUBLIC_GROUP) and type=2 (GROUP). For type=3 (PRIVATE), returns an empty array. Added in v2.52.0. |
| last_message | string | Last sent message in this dialog. |
| last_message_date_sent | timestamp | Timestamp of last sent message in this dialog. |
| last_message_user_id | int | ID of the user who sent last message in this dialog. |
| unread_messages_count | int | Number of unread messages in this dialog for a current user. |
| is_join_required | int (0 or 1) | Defines whether a user must join the dialog before sending/receiving messages via XMPP. Applies only to type=2 (GROUP). 0 - join not required. 1 - join required. Null if type=1 or type=3. |
| data | object | - Information about class and fields in Custom Objects. - Any dialog can be extended using Custom Objects to store additional parameters. |
| data.class_name | string | Class name in Custom Objects. |
| data.{field_name_N} | string | Field name of class in Custom Objects. Can be many: 1..N. |
Chat