Page Comparison

...

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

.page

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

cursor.pages

Количество страниц с указанным лимитом

collection.*.id

ID чата

collection.*.name

Название чата (Имя клиента)

collection.*.image

Иконка чата (Фото клиента)

collection.*.createdAt

Дата создания чата

collection.*.updatedAt

Дата обновления чата

collection.*.contact.id

Внутренний ID контакта

collection.*.contact.originalId

Оригинальный ID контакта

collection.*.gates.*.id

ID шлюза

collection.*.gates.*.subscribed

Статус подписки на шлюз

collection.*.gates.*.unreadMessages

Количество непрочитанных уведомлений в шлюзе

collection.*.gates.*.channel.id

ID канала

collection.*.gates.*.channel.active

Статус активности канала

collection.*.gates.*.channel.occupied

Статус подключения канала

collection.*.gates.*.channel.type

Тип канала

collection.*.gates.*.channel.name

Название канала

collection.*.gates.*.channel.referrer

Внутренняя метка отслеживания

collection.*.gates.*.channel.link

Ссылка на канал

collection.*.gates.*.channel.app

Ссылка приложения на канал

collection.*.gates.*.channel.createdAt

Дата создания канала

collection.*.gates.*.channel.updatedAt

Дата обновления канала

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

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

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

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

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

Code Block

{
    "id": 2120,
    "name": "Helena",
    "image": "https:\/\/messenger.smartsender.eu\/storage\/projects\/1\/TVZhdSAq9XeqMktQSo7f8qZVHnt4vsy5BmnVt8gl.jpeg",
    "contact": {
        "id": 3410,
        "originalId": 2240
    },
    "gates": [
        {
            "id": 3404,
            "subscribed": true,
            "unreadMessages": 0,
            "channel": {
                "id": 2,
                "active": true,
                "occupied": true,
                "type": "viber",
                "name": "smartsender",
                "referrer": 1,
                "link": "https:\/\/viber.me\/smartsender",
                "app": "viber:\/\/pa?chatURI=smartsender",
                "createdAt": "2019-08-02 18:26:33",
                "updatedAt": "2019-11-25 15:07:43"
            }
        }
    ],
    "createdAt": "2019-10-23 16:16:38",
    "updatedAt": "2019-11-25 21:43:22"
}

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

Название	Описание
id	ID чата
name	Название чата (Имя клиента)
image	Иконка чата (Фото клиента)
createdAt	Дата создания чата
updatedAt	Дата обновления чата
contact.id	Внутренний ID контакта
contact.originalId	Оригинальный ID контакта
gates.*.id	ID шлюза
gates.*.subscribed	Статус подписки на шлюз
gates.*.unreadMessages	Количество непрочитанных уведомлений в шлюзе
gates.*.channel.id	ID канала
gates.*.channel.active	Статус активности канала
gates.*.channel.occupied	Статус подключения канала
gates.*.channel.type	Тип канала
gates.*.channel.name	Название канала
gates.*.channel.referrer	Внутренняя метка отслеживания
gates.*.channel.link	Ссылка на канал
gates.*.channel.app	Ссылка приложения на канал
gates.*.channel.createdAt	Дата создания канала
gates.*.channel.updatedAt	Дата обновления канала

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

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

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

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

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

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

Code Block
{ "state": true }

Закрыть выбранный чат.

Позволяет закрыть выбранный чат.

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

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

Code Block
{ "state": true }

Закрыть выбранный Назначить чат.

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

Code Block
PUTPOST https://api.smartsender.eucom/v1/chats/{chatId}/closeforward/{operatorId}

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

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

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

...

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

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

Название	Описание	Валидация
page	Запрашиваемая страница	Минимальное значение 1
limitation	Количество данных для вывода на странице	Минимальное значение 1, максимальное 20

……

Versions Compared

Old Version 2

New Version Current

Key