Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET https://api.smartsender.eucom/v1/chats

Основные параметры:

Название

Описание

Валидация

page

Запрашиваемая страница

Минимальное значение 1

limitation

Количество данных для вывода на странице

Минимальное значение 1, максимальное 20

term

Ключевое слово для поиска

Не обязательно, String

state

Статус чата

Не обязательно, Enum
- open, если только часы с открытым статусом
- closed, если только чаты с закрытым статусом

selector[name]

Фильтр для чатов

Не обязательно, Enum
- none, все чаты
- private, только чаты определенного оператора
- unread, только не прочитанные чаты

selector[operatorId]

Выбор оператора для фильтра private

Обязательно если selector[name] равен private. Идентификатор нужного оператора

В случае успешного ответа получите следующее:

Code Block
{
    "cursor": Cursor,
    "collection": Chats[]
}

Описание ответа:

Название

Описание

cursor

Объект типа Cursor

collection

Массив объектов типа Chat

Получение по ID.

Позволяет получить информацию об указанном чате.

Code Block
GET https://api.smartsender.eucom/v1/chats/{chatId}

В случае успешного ответа получите объект типа Chat.

Прочитать выбранный чат.

...

Code Block
PUT https://api.smartsender.eucom/v1/chats/{chatId}/read

В случае успешного ответа получите следующее:

...

Code Block
PUT https://api.smartsender.eucom/v1/chats/{chatId}/close

В случае успешного ответа получите следующее:

Code Block
{
    "state": true
}

Назначить чат.

Позволяет назначить выбранный чат определенному оператору.

Code Block
POST https://api.smartsender.com/v1/chats/{chatId}/forward/{operatorId}

Основные параметры:

Название

Описание

text

Информативный текст - описание назначения

В случае успешного ответа получите следующее:

...

Code Block
GET https://api.smartsender.eucom/v1/chats/{chatId}/messages

Основные параметры:

Название

Описание

Валидация

page

Запрашиваемая страница

Минимальное значение 1

limitation

Количество данных для вывода на странице

Минимальное значение 1, максимальное 20

……