Chats API - ua
- Anastasiia
- Smart Sender
За допомогою цього 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 |