messages.getThreadsList rest api

Возвращает список диалогов пользователя.

Для вызова функции требуется привилегия messages.

Параметры

Имя Тип Описание
uidunsigned int64идентификатор пользователя; обязательный параметр
offsetintотступ от последней записи; по-умолчанию 0
limitintмаксимальное количество записей в выдаче; по-умолчанию 10; максимум 1000

Результат

Возвращает диалоги в обратном хронологическом порядке (последние сначала).

Формат ответа для json-выдачи (результат для xml аналогичен):

  1. [
  2.     {
  3.       "incoming": 3, // количество входящих сообщений
  4.       "outgoing": 2, // количество исходящих сообщений
  5.       "unread": 0, // количество непрочитанных сообщений
  6.       "time": 1279882541, // время последнего сообщения в формате unixtime
  7.       "user": { // корреспондент
  8.         // объект, аналогичный результату выдачи users.getInforest
  9.       },
  10.     },
  11.     ...
  12. ]

Коды ошибок

КодОписание
1Unknown error: Please resubmit the request.
2Unknown method called.
3Service Unavailable. Please try again later.
4Method is deprecated.
100One of the parameters specified is missing or invalid.
102User authorization failed: the session key or uid is incorrect.
103Application lookup failed: the application id is not correct.
104Incorrect signature.
105Application is not installed for this user.
200Permission error: the application does not have permission to perform this action.

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

http://www.appsmail.ru/platform/api?method=messages.getThreadsList&
app_id=123456&session_key=551fd0e4779e35859dfccd03397dc8a0&
sig=95a393ed7639184a52f7a17b6771a92&offset=20&limit=30

Пример ответа в формате JSON

  1. [
  2.     {
  3.       "outgoing": 2,
  4.       "unread": 0,
  5.       "time": 1279882541,
  6.       "incoming": 3,
  7.       "user": {
  8.         "link": "http://my.mail.ru/mail/ivanivanov/",
  9.         "location": {
  10.           "country": {
  11.             "name": "Россия",
  12.             "id": "24"
  13.           },
  14.           "city": {
  15.             "name": "Москва",
  16.             "id": "25"
  17.           },
  18.           "region": {
  19.             "name": "Москва",
  20.             "id": "999999"
  21.           }
  22.         },
  23.         "uid": "12345678901234567890",
  24.         "nick": "Петя",
  25.         "sex": 0,
  26.         "is_online": 0,
  27.         "pic_small": "http://avt.appsmail.ru/mail/ivanivanov/_avatarsmall",
  28.         "pic_big": "http://avt.appsmail.ru/mail/ivanivanov/_avatarbig",
  29.         "pic": "http://avt.appsmail.ru/mail/ivanivanov/_avatar",
  30.         "last_name": "Иванов",
  31.         "birthday": "14.03.1975",
  32.         "first_name": "Иван"
  33.       }
  34.     }
  35. ]

Пример ответа в формате XML

  1. <response_messages_getThreadsList>
  2.   <thread>
  3.     <incoming>3</incoming>
  4.     <outgoing>2</outgoing>
  5.     <time>1279882541</time>
  6.     <unread>0</unread>
  7.     <user>
  8.       <birthday>14.03.1975</birthday>
  9.       <first_name>Иван</first_name>
  10.       <is_online>0</is_online>
  11.       <last_name>Иванов</last_name>
  12.       <link>http://my.mail.ru/mail/ivanivanov/</link>
  13.       <location>
  14.         <city>
  15.           <name>Москва</name>
  16.           <id>25</id>
  17.         </city>
  18.         <country>
  19.           <name>Россия</name>
  20.           <id>24</id>
  21.         </country>
  22.         <region>
  23.           <name>Москва</name>
  24.           <id>999999</id>
  25.         </region>
  26.       </location>
  27.       <nick>Петя</nick>
  28.       <pic>http://avt.appsmail.ru/mail/ivanivanov/_avatar</pic>
  29.       <pic_big>http://avt.appsmail.ru/mail/ivanivanov/_avatarbig</pic_big>
  30.       <pic_small>http://avt.appsmail.ru/mail/ivanivanov/_avatarsmall</pic_small>
  31.       <sex>0</sex>
  32.       <uid>12345678901234567890</uid>
  33.     </user>
  34.   </thread>
  35. </response_messages_getThreadsList>

См. также

Использование REST API

Функции REST API