Перейти к содержимому

Список сообщений чата

GET/messages

Метод для получения списка сообщений бесед, каналов, тредов и личных сообщений.

Для получения сообщений вам необходимо знать chat_id требуемой беседы, канала, треда или диалога, и указать его в URL запроса. Сообщения будут возвращены в порядке убывания даты отправки (то есть, сначала будут идти последние сообщения чата). Для получения более ранних сообщений чата доступны параметры per и page.

Параметры строки запроса

chat_id
integer, (int32)
*
Идентификатор чата (беседа, канал, диалог или чат треда)
per
integer, (int32)
Количество возвращаемых сущностей за один запрос
По умолчанию:
25
Диапазон:
1 — 50
page
integer, (int32)
Страница выборки
По умолчанию:
1
sort[{field}]
string
Составной параметр сортировки сущностей выборки. На данный момент сортировка доступна только по полю id (идентификатор сообщения).
Возможные значения
asc
По возрастанию
desc
По убыванию

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор сообщения
entity_type
string
*
Тип сущности, к которой относится сообщение
Возможные значения
discussion
Беседа или канал
thread
Тред
user
Пользователь
entity_id
integer, (int32)
*
Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя)
chat_id
integer, (int32)
*
Идентификатор чата, в котором находится сообщение
content
string
*
Текст сообщения
user_id
integer, (int32)
*
Идентификатор пользователя, создавшего сообщение
created_at
string, (date-time)
*
Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
url
string
*
Прямая ссылка на сообщение
files[]
array of objects
*
Прикрепленные файлы
id
integer, (int32)
*
Идентификатор файла
key
string
*
Путь к файлу
name
string
*
Название файла с расширением
file_type
string
*
Тип файла
Возможные значения
file
Обычный файл
image
Изображение
url
string
*
Прямая ссылка на скачивание файла
width
nullableinteger, (int32)
Ширина изображения в пикселях
height
nullableinteger, (int32)
Высота изображения в пикселях
buttons[][]
array of arrays of objects
*
Массив строк, каждая из которых представлена массивом кнопок
text
string
*
Текст, отображаемый на кнопке
Длина:
<= 255 символов
url
string
Ссылка, которая будет открыта по нажатию кнопки
data
string
Данные, которые будут отправлены в исходном вебхуке по нажатию кнопки
Длина:
<= 255 символов
thread
nullableobject
*
Тред сообщения
id
integer, (int64)
*
Идентификатор созданного треда (используется для отправки POSTновых комментариев в тред)
chat_id
integer, (int64)
*
Идентификатор чата треда (используется для отправки POSTновых комментариев в тред и получения GETсписка комментариев)
message_id
integer, (int64)
*
Идентификатор сообщения, к которому был создан тред
message_chat_id
integer, (int64)
*
Идентификатор чата сообщения
updated_at
string, (date-time)
*
Дата и время обновления треда (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
forwarding
nullableobject
*
Информация о пересланном сообщении
original_message_id
integer, (int32)
*
Идентификатор оригинального сообщения
original_chat_id
integer, (int32)
*
Идентификатор чата, в котором находится оригинальное сообщение
author_id
integer, (int32)
*
Идентификатор пользователя, создавшего оригинальное сообщение
original_created_at
string, (date-time)
*
Дата и время создания оригинального сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
original_thread_id
nullableinteger, (int32)
*
Идентификатор треда, в котором находится оригинальное сообщение
original_thread_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому был создан тред, в котором находится оригинальное сообщение
original_thread_parent_chat_id
nullableinteger, (int32)
*
Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение
parent_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому написан ответ
display_avatar_url
nullablestring
*
Ссылка на аватарку отправителя сообщения
display_name
nullablestring
*
Полное имя отправителя сообщения
Список сообщений чата
Ответ 200