messages.getDialogs

Возвращает список диалогов текущего пользователя или сообщества. Актуальный метод: messages.getConversations.

Данный метод устарел и может быть отключён через некоторое время, пожалуйста, избегайте его использования.

Этот метод можно вызвать с ключом доступа пользователя, полученным в Standalone-приложении через Implicit Flow.

Требуются права доступа: messages.

Этот метод можно вызвать с ключом доступа сообщества.

Требуются права доступа: messages.

Параметры

offset

string

Смещение, необходимое для выборки определённого подмножества диалогов.

count

string

Количество диалогов, которое необходимо получить.

start_message_id

string

Идентификатор сообщения, начиная с которого нужно вернуть список диалогов (подробности смотрите ниже).

preview_length

string

Количество символов, по которому нужно обрезать сообщение. Укажите 0, если вы не хотите обрезать сообщение (по умолчанию сообщения не обрезаются).

Обратите внимание, текст обрезается по словам, точное число символов может не совпадать с указанным значением.

unread

string

1 — вернуть только диалоги, в которых есть непрочитанные входящие сообщения. По умолчанию: 0.

important

string

1 — вернуть диалоги с пометкой «Важные» (для сообщений сообществ).

unanswered

string

1 — вернуть диалоги с пометкой «Неотвеченные» (для сообщений сообществ).

user_id

string

Идентификатор пользователя, последнее сообщение в переписке с которым необходимо вернуть.

Если был передан параметр start_message_id, будет найдена позиция диалога в списке, идентификатор последнего сообщения которого равен start_message_id (или ближайший к нему более ранний). Начиная с этой позиции будет возвращено count диалогов. Смещение offset в этом случае будет отсчитываться от этой позиции (оно может быть отрицательным).

Результат

После успешного выполнения возвращает объект, содержащий число результатов в поле count и массив объектов, описывающих диалоги, в поле items. Если у пользователя есть непрочитанные диалоги и параметр unread=0, будет возвращено поле unread_dialogs, содержащее количество непрочитанных диалогов.

Объект, описывающий диалог, содержит следующие поля:

•
unread — количество непрочитанных сообщений (если все сообщения прочитаны, поле не возвращается);
•
message — объект, описывающий личное сообщение;
•
in_read — идентификатор последнего сообщения, прочитанного текущим пользователем;
•
out_read — идентификатор последнего сообщения, прочитанного собеседником.

Если был передан параметр start_message_id, будет также возвращено поле real_offset — итоговое смещение данного подмножества диалогов (оно может быть отрицательным, если был указан отрицательный offset).

Коды ошибок

В ходе выполнения могут произойти общие ошибки.