GET api/2.0/mail/conversations
Важно
Для этой функции требуется аутентификация.
Описание
Возвращает диалоги с указанными в запросе параметрами, если с даты последней проверки были изменения.
Параметры
| Название | Описание | Тип | Пример |
| folder sent in url |
Тип папки: 1 — входящие, 2 — отправленные, 3 — черновики, 4 — корзина, 5 — спам Необязательно |
номер | 1234 |
| unread sent in url |
Статус разговора: непрочитанные (true), прочитанные (false) или все (null) сообщения Необязательно |
логический | true |
| attachments sent in url |
Определяет, есть ли в разговоре вложения или нет: с вложениями (true), без вложений (false) или все сообщения (null) Необязательно |
логический | true |
| period_from sent in url |
Дата начала периода поиска Необязательно |
номер | 1234 |
| period_to sent in url |
Дата окончания периода поиска Необязательно |
номер | 1234 |
| important sent in url |
Важный разговор или нет Необязательно |
логический | true |
| from_address sent in url |
Почтовый адрес, с которого пришло письмо Необязательно |
строковый | текст |
| to_address sent in url |
Адрес электронной почты, на который пришло письмо Необязательно |
строковый | текст |
| mailbox_id sent in url |
Идентификатор почтового ящика получателя Необязательно |
номер | 1234 |
| tags sent in url |
Идентификаторы тегов, связанных с целевым разговором Необязательно |
Collection of numbers collection |
1234 |
| search sent in url |
Текст для поиска в теле и теме беседы Необязательно |
строковый | текст |
| page_size sent in url |
Количество разговоров на странице Необязательно |
номер | 1234 |
| sortorder sent in url |
Порядок сортировки по дате: «по возрастанию» — восходящий, «по убыванию» — нисходящий | строковый | текст |
| from_date sent in url |
Дата, с которой был выполнен поиск разговора Необязательно |
дата и время | Roundtrip format: 2008-04-10T06-30-00.000Z |
| from_message sent in url |
Сообщение, из которого выполняется поиск разговора Необязательно |
номер | 1234 |
| with_calendar sent in url |
У разговора есть календарь или нет Необязательно |
логический | true |
| user_folder_id sent in url |
Идентификатор папки пользователя Необязательно |
номер | 1234 |
| prev_flag sent in url |
Направление сортировки списка разговоров (предыдущий или следующий) Необязательно |
логический | true |
Пример
GET api/2.0/mail/conversations?from_address=some+text&to_address=some+text&tags=%5b1234%5d&search=some+text&sortorder=some+text&from_date=2008-04-10T06-30-00.000Z Host: yourportal.r7-office.ru Content-Type: application/json Accept: application/json
Возвращает
Список отфильтрованных разговоров.
