Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

С помощью данного API вы можете получать список созданных чатов, получать информацию о чате, помечать как “прочитанное“ или “закрыть“.

Вы так же можете получать сообщения из переписки или отправлять сообщение.

Чтение.

Позволяет просматривать существующие чаты.

GET https://api.smartsender.com/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.

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

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

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

Название

Описание

cursor

Объект типа Cursor

collection

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

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

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

GET https://api.smartsender.com/v1/chats/{chatId}

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

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

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

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

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

{
    "state": true
}

 

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

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

PUT https://api.smartsender.com/v1/chats/{chatId}/close

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

{
    "state": true
}

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

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

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

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

Название

Описание

text

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

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

{
    "state": true
}

 

Получить сообщения выбранного чат.

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

GET https://api.smartsender.com/v1/chats/{chatId}/messages

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

Название

Описание

Валидация

page

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

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

limitation

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

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

……

  • No labels