Получить список цепочек сообщений

GET /message-threads

Получает список цепочек сообщений.

Примеры запросов

curl -X GET 'https://tasks.yandex.ru/api/v1/message-threads?folder=INBOX,UNREAD' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/message-threads"
params = {
  'folder': 'INBOX,UNREAD'
}
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, params=params, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/message-threads',
  'qs': {'folder': 'INBOX,UNREAD'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр

Описание

folder

string

Папки, в которых находится цепочка:

  • INBOX — Входящие.
  • OUTBOX — Отправленные.
  • AUTOMATIC_NOTIFICATION — Уведомления.
  • IMPORTANT — Важные.
  • UNREAD — Непрочитанные.

Можно указать несколько значений через запятую.

folder_ne

string

Папки, в которых не искать цепочку:

  • INBOX — Входящие.
  • OUTBOX — Отправленные.
  • AUTOMATIC_NOTIFICATION — Уведомления.
  • IMPORTANT — Важные.
  • UNREAD — Непрочитанные.

Можно указать несколько значений через запятую.

sort

string

Параметры для сортировки:

  • id — идентификатор страницы заданий;
  • created — дата создания страницы заданий по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 300.

id_gt

string

Объекты с идентификатором больше указанного значения.

id_gte

string

Объекты с идентификатором больше или равным указанному значению.

id_lt

string

Объекты с идентификатором меньше указанного значения.

id_lte

string

Объекты с идентификатором меньше или равным указанному значению.

created_gt

string

Объекты, выданные или созданные после указанной даты.

created_gte

string

Объекты, выданные или созданные после указанной даты включительно.

created_lt

string

Объекты, выданные или созданные до указанной даты.

created_lte

string

Объекты, выданные или созданные до указанной даты включительно.

Ответ

Содержит список цепочек сообщений в массиве items:

{
  "items": [
    {message thread details 1},
    {message thread details 2},
    ...
    {message thread details n}
  ],
  "has_more": false
}
Пример ответа
{
  "items": [
    {
      "id": "643933af08583e0a19c2167e",
      "topic": {
        "EN": "Test bonus"
      },
      "interlocutors_inlined": true,
      "interlocutors": [
        {
          "id": "6c6e20dc86cca2ae787afcb2629de162",
          "role": "REQUESTER",
          "myself": true
        },
        {
          "id": "a1b0b42923c429daa2c764d7ccfc364d",
          "role": "USER"
        }
      ],
      "messages_inlined": true,
      "messages": [
        {
          "text": {
            "EN": "Thank you"
          },
          "from": {
            "id": "6c6e20dc86cca2ae787afcb2629de162",
            "role": "REQUESTER",
            "myself": true
          },
          "created": "2023-04-14T11:06:23.096"
        }
      ],
      "compose_details": {
        "recipients_select_type": "DIRECT",
        "recipients_ids": [
          "a1b0b42923c429daa2c764d7ccfc364d\""
        ]
      },
      "meta": {},
      "folders": [
        "OUTBOX"
      ],
      "answerable": false,
      "created": "2023-04-14T11:06:23.096"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком цепочек сообщений и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

Предыдущая
Сообщения исполнителям
Следующая
Добавить цепочку сообщений в папку