messages.getThread rest api

Возвращает сообщения в выбранном диалоге.

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

Параметры

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

Результат

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

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

  1. [
  2.     {
  3.       // текст сообщения, отфильтрованный от HTML тегов
  4.       "filtered_message": "раз два три",
  5.       "type": 0, // тип сообщения 0-входящее 1-исходящее
  6.       "time": 1279882541 // время создания сообщения в формате unixtime
  7.     },
  8.     ...
  9. ]

Коды ошибок

КодОписание
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.getThread&
app_id=123456&session_key=551fd0e4779e35859dfccd03397dc8a0&
sig=95a393ed7639184a52f7a17b6771a92&offset=20&limit=30&
uid=12345678901234567890

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

  1. [
  2.     {
  3.       "time":1279882541,
  4.       "filtered_message":"раз два три",
  5.       "type":0
  6.     },
  7.     {
  8.       "time":1279785758,
  9.       "filtered_message":"234324234",
  10.       "type":1
  11.     },
  12.     {
  13.       "time":1279785408,
  14.       "filtered_message":"5324",
  15.       "type":1
  16.     },
  17.     {
  18.       "time":1279785404,
  19.       "filtered_message":"123",
  20.       "type":1
  21.     }
  22. ]

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

  1. <response_messages_getThread>
  2.   <post>
  3.     <filtered_message>раз два три</filtered_message>
  4.     <time>1279882541</time>
  5.     <type>0</type>
  6.   </post>
  7.   <post>
  8.     <filtered_message>234324234</filtered_message>
  9.     <time>1279785758</time>
  10.     <type>1</type>
  11.   </post>
  12.   <post>
  13.     <filtered_message>5324</filtered_message>
  14.     <time>1279785408</time>
  15.     <type>1</type>
  16.   </post>
  17.   <posts>
  18.     <filtered_message>123</filtered_message>
  19.     <message>123</message>
  20.     <time>1279785404</time>
  21.     <type>1</type>
  22.   </post>
  23. </response_messages_getThread>

См. также

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

Функции REST API