messages.md

Текстовые сообщения

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

GET /api/v1/message/get-all вернёт список сообщений в рамках консультации.

Запрос:

Имя	Тип	Описание
requestId	string	уникальный идентификатор консультации
limit	integer	кол-во (записей в ответе)
offset	integer	смещение (сколько записей пропустить)

Ответ:

Объект Сообщение

{
  "items": [
    {
      //.. объект сообщение
    }
  ],
  "count": 10,
  "totalCount": 15
}

Получение списка непрочитанных сообщений

GET /api/v1/message/get-all-unread вернёт список непрочитанных сообщений в рамках консультации.

Запрос:

Имя	Тип	Описание
requestId	string	уникальный идентификатор консультации
limit	integer	кол-во (записей в ответе)
offset	integer	смещение (сколько записей пропустить)

Ответ:

Объект Сообщение

{
  "items": [
    {
      //.. объект сообщение
    }
  ],
  "count": 10,
  "totalCount": 15
}

Добавление сообщения

POST /api/v1/message/add вернёт информацию о добавленном сообщении.

Запрос:

Имя	Тип	Описание
requestId	integer	уникальный идентификатор консультации
text	string	текстовое содержимое сообщения
attachmentId	string	уникальный идентификатор медиа объекта

Ответ:

Объект Сообщение

{
  //.. объект сообщение
}

Пометить сообщения как прочитанные

POST /api/v1/message/mark-as-read вернёт информацию о дате выполнения запроса.

Запрос:

Имя	Тип	Описание
messageIds	array	массив идентификаторов сообщений

Ответ:

{
    "executedAtUtc": "2017-05-26T13:17:59.994Z"
}