За допомогою цього API ви можете отримувати список створених чатів, отримувати інформацію про чат, позначати як "прочитане" або "закрити". Ви також можете отримувати повідомлення з листування або надсилати повідомлення.
Читання.
Дозволяє переглядати існуючі чати
GET https://api.smartsender.com/v1/chats
Основні параметри:
Назва | Опис | Валідація |
---|---|---|
page | Запрошувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виводу на сторінці | Мінімальне значення 1, максимальне 20 |
У разі успішної відповіді отримаєте таке:
{ "cursor": Cursor, "collection": Chats[] }
Опис відповіді:
Отримання 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 |