DocumentMessage.List

DocumentMessage.List

Метод «DocumentMessage.List» позволяет прочитать ленту сообщений по документу.

Параметры запроса

Адрес запроса: https://online.sbis.ru/service/

Параметр
* — обязательный

Тип

Описание

ExtraFields

список

список дополнительных полей, которые надо вернуть в результате

Filter*

запись

данные для поиска сообщений

 

document*

строка
UUID

идентификатор документа

fromDateTime

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата, начиная с которой надо получить сообщения

toDateTime

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата, до которой надо получить сообщения

order

текст

сортировка результата относительно даты отправки сообщения: «asc» — по возрастанию, «desc» — по убыванию

Sorting*

null

правила сортировки списка. Передается в запросе с пустым значением

Pagination*

запись

постраничная или курсорная навигация — способ получения данных. В зависимости от выбранного значения доступны для указания параметры:

  • «Постраничная» — «РазмерСтраницы» и «Страница»;
  • «Курсорная» — «Direction», «Limit» и поля объекта «Position».

 

РазмерСтраницы*

число

размер получаемой страницы

Страница*

число

номер страницы, начиная с 0

Direction*

текст

направление чтения результата относительно курсора: «backward» — назад, «forward» — вперед

Limit*

число

размер полученной страницы

Position

запись

строка результата, от которой нужно получить следующую порцию сообщений

 

theme*

строка
UUID

идентификатор диалога

message*

строка
UUID

идентификатор сообщения

datetime*

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата и время отправки сообщения

Результат

Параметр
* — обязательный

Тип

Описание

theme

строка
UUID

идентификатор диалога

message

строка
UUID

идентификатор сообщения

datetime

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата и время отправки сообщения

model

запись

модель сообщения

 

uuid

строка
UUID

идентификатор сообщения

dialogID

строка
UUID

идентификатор диалога

text_model

json

текст сообщения в формате JsonML

serviceObject

json

метаданные сообщения

timestamp

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата последней смены свойств сообщения

typeMsg

текст

тип сообщения

senderID

строка
UUID

идентификатор автора сообщения из сервиса профилей

dateSend

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата отправки сообщения

deleted

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата удаления сообщения

edited

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата последнего редактирования текста или списка файлов

aboutEdition

строка
UUID

автор последней редакции сообщения

readReceiver

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата прочтения сообщения одним из получателей

readMy

строка
«YYYY-MM-DDThh:mm:ss±hh»

дата прочтения текущим пользователем

receiverList

массив строк

получатели сообщения — список идентификаторов сервиса профилей

receiverCount

число

количество получателей

files

список записей

файлы, отправленные с сообщением

 

attachId

строка
UUID

идентификатор файла на СБИС Диске

redactionId

текст

идентификатор редакции файла

fileName

текст

имя файла

size

число

размер файла

urlToOpen

текст

ссылка на страницу просмотра файла

relativeUrl

текст

ссылка для скачивания файла

toMe

логический

текущий пользователь является получателем сообщения

answer

строка
UUID

сообщение, на которое сделан ответ

Примеры

Пример запроса с постраничной навигацией.

Пример запроса с курсорной навигацией.

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.