Chats API
С помощью данного API вы можете получать список созданных чатов, получать информацию о чате, помечать как “прочитанное“ или “закрыть“.
Вы так же можете получать сообщения из переписки или отправлять сообщение.
Чтение.
Позволяет просматривать существующие чаты.
GET https://api.smartsender.com/v1/chats
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
term | Ключевое слово для поиска | Не обязательно, String |
state | Статус чата | Не обязательно, Enum |
selector[name] | Фильтр для чатов | Не обязательно, Enum |
selector[operatorId] | Выбор оператора для фильтра private | Обязательно если selector[name] равен private. Идентификатор нужного оператора |
В случае успешного ответа получите следующее:
{
"cursor": Cursor,
"collection": Chats[]
}
Описание ответа:
Получение по ID.
Позволяет получить информацию об указанном чате.
GET https://api.smartsender.com/v1/chats/{chatId}
В случае успешного ответа получите объект типа Chat.
Прочитать выбранный чат.
Позволяет прочитать все уведомления в выбранном чате.
В случае успешного ответа получите следующее:
Закрыть выбранный чат.
Позволяет закрыть выбранный чат.
В случае успешного ответа получите следующее:
Назначить чат.
Позволяет назначить выбранный чат определенному оператору.
Основные параметры:
Название | Описание |
|---|---|
text | Информативный текст - описание назначения |
В случае успешного ответа получите следующее:
Получить сообщения выбранного чат.
Позволяет получить сообщения в выбранном чате
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
……