Метод для получения списка сообщений бесед, каналов, тредов и личных сообщений.
Для получения сообщений вам необходимо знать chat_id требуемой беседы, канала, треда или диалога, и указать его в URL запроса. Сообщения будут возвращены в порядке убывания даты отправки (то есть, сначала будут идти последние сообщения чата). Для получения более ранних сообщений чата доступны параметры per и page.
|
Запрос
|
|||
|---|---|---|---|
| chat_id | integer* | Идентификатор чата (беседа, канал, диалог или чат треда) | |
| per | integer | Количество возвращаемых сущностей за один запрос (по умолчанию 25, максимум 50) | |
| page | integer | Страница выборки (по умолчанию 1) | |
|
Ответ
|
|||
| data | array of objects | Массив списка сообщений | |
| id | integer | Идентификатор сообщения | |
| entity_type | string | Тип сущности, к которой относится сообщение: беседа/канал (discussion), тред (thread) или пользователь (user) | |
| entity_id | integer | Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя) | |
| chat_id | integer | Идентификатор чата, в котором находится сообщение | |
| content | string | Текст сообщения | |
| user_id | integer | Идентификатор пользователя, создавшего сообщение | |
| created_at | string | Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
| files | array of objects | Прикреплённые файлы | |
| id | integer | Идентификатор файла | |
| key | string | Путь к файлу | |
| name | string | Название файла | |
| file_type | string | Тип файла: файл (file), изображение (image) | |
| url | string | Прямая временная ссылка на скачивание файла | |
| buttons | array of array of objects | Массив строк, каждая из которых представлена массивом кнопок. | |
| text | string | Текст, отображаемый на кнопке пользователю | |
| url | string | Ссылка, которая будет открыта по нажатию кнопки | |
| data | string | Данные, которые будут отправлены в исходящем вебхуке по нажатию кнопки | |
| thread | object или null | Тред сообщения. Возвращается как null, если у сообщения нет комментариев. | |
| id | integer | Идентификатор треда | |
| chat_id | integer | Идентификатор чата треда (используется для отправки новых комментариев в тред и получения списка комментариев) | |
| forwarding | object или null | Информация о пересылаемом сообщении. Возвращается как null, если это сообщение не является пересылаемым с сохранением автора. | |
| original_message_id | integer | Идентификатор оригинального сообщения | |
| original_chat_id | integer | Идентификатор чата, в котором находится оригинальное сообщение | |
| author_id | integer | Идентификатор пользователя, создавшего оригинальное сообщение | |
| original_created_at | integer | Дата и время создания оригинального сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
| original_thread_id | integer или null | Идентификатор треда, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
| original_thread_message_id | integer или null | Идентификатор сообщения, к которому был создан тред, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
| original_thread_parent_chat_id | integer или null | Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
| parent_message_id | integer или null | Идентификатор сообщения, к которому написан ответ. Возвращается как null, если сообщение не является ответом. | |
|
Возможные ошибки запроса (errors code)
|
|||
| blank | Поле не может быть пустым | ||
| exclusion | Поле имеет недопустимое значение | ||
| not_found | Не удалось найти | ||
|
|||
{
"data": [
{
"id": 1194277,
"entity_type": "discussion",
"entity_id": 198,
"chat_id": 198,
"content": "Это сообщение тоже попадёт в экспорт",
"user_id": 12,
"created_at": "2023-09-18T13:43:32.000Z",
"files": [],
"buttons": [],
"thread": {
"id": 2633,
"chat_id": 44997
},
"forwarding": null,
"parent_message_id": null
},
{
"id": 1194276,
"entity_type": "discussion",
"entity_id": 198,
"chat_id": 198,
"content": "**Andrew** добавил **Export bot** в беседу",
"user_id": 12,
"created_at": "2023-09-18T13:43:27.000Z",
"files": [],
"buttons": [],
"thread": null,
"forwarding": null,
"parent_message_id": null
},
{
"id": 1194275,
"entity_type": "discussion",
"entity_id": 198,
"chat_id": 198,
"content": "**Andrew** создал беседу",
"user_id": 12,
"created_at": "2023-09-18T13:43:19.000Z",
"files": [],
"buttons": [],
"thread": null,
"forwarding": null,
"parent_message_id": null
}
]
}