Page Comparison

За допомогою цього API ви можете отримувати список створених чатів, отримувати інформацію про чат, позначати як "прочитане" або "закрити". Ви також можете отримувати повідомлення з листування або надсилати повідомлення.

Читання.

Дозволяє переглядати існуючі чати

Code Block
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. Ідентифікатор оператора

У разі успішної відповіді отримаєте таке:

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

Опис відповіді:

Назва	Опис
cursor	Об'єкт типу Cursor
collection	Масив об'єктів типу Chat

Отримання ID.

Дозволяє отримати інформацію про вказаний чат.

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

У разі успішної відповіді отримайте об'єкт типу Chat .

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

Дозволяє прочитати всі повідомлення у вибраному чаті.

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

У разі успішної відповіді отримаєте таке:

Code Block
{ "state": true }

Закрити вибраний чат.

Дозволяє закрити обраний чат.

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

У разі успішної відповіді отримаєте таке:

Code Block
{ "state": true }

Призначити чат.

Дозволяє призначити обраний чат для певного оператора.

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

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

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

У разі успішної відповіді отримаєте таке:

Code Block
{ "state": true }

Отримати повідомлення вибраного чату.

Дозволяє отримати повідомлення у вибраному чаті

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

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

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

Versions Compared

Old Version 1

New Version Current

Key