Дозволяє переглядати, знаходити та оновлювати канали всередині Smart Messenger.
Читання.
Дозволяє переглянути підключені канали у проекті.
| Code Block |
|---|
GET https://api.smartsender.com/v1/channels |
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
page | Запрошувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виводу на сторінці | Мінімальне значення 1, максимальне 20 |
У разі успішної відповіді отримаєте таке:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Channel[]
}
|
Опис відповіді:
Отримання по ID.
Дозволяє переглянути підключений канал у проекті з ідентифікатора.
| Code Block |
|---|
GET https://api.smartsender.com/v1/channels/{channelId} |
У разі успішної відповіді отримайте об'єкт типу Channel
Оновлення.
Дозволяє змінити активність вибраного каналу.
| Code Block |
|---|
PUT https://api.smartsender.com/v1/channels/{channelId} |
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
state | Статус активності | Boolean |
У разі успішної відповіді отримаєте таке:
| Code Block |
|---|
{
"state": true
} |
Створення шлюзу.
Дозволяє створити шлюз для каналу. Якщо шлюз вже створено з цим ідентифікатором, буде повернуто вже існуючий шлюз. Контакт буде створено автоматично.
| Code Block |
|---|
POST https://api.smartsender.com/v1/channels/{channelId}/gates |
Приклади URL:
Назва | Опис | Валідація |
|---|---|---|
channelId | Ідентифікатор каналу | Обов'язкове, число. Список каналів, що підтримуються:
|
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
identifier | Ідентифікатор клієнта у месенджері. | Обов'язкове, число.
|
firstName | Ім'я клієнта | Обов'язкове, рядок, максимальна довжина 255 символів |
lastName | Прізвище клієнта | Не обов'язкове, рядок, максимальна довжина 255 символів |
Емейл клієнта | Не обов'язкове, емейл | |
phone | Телефон клієнта | Не обов'язковий, телефон у міжнародному форматі з використанням “+“ |
parameters | Перелік змінних | Не обов'язкове, масив ключ-значення зі змінними для цього контакту |
У разі успішної відповіді отримайте об'єкт типу Gate.
| Info |
|---|
На даний момент Ви можете використовувати створення шлюзу через API виключно для каналів WhatsАpp і найближчим часом буде доступно для Viber каналів. Для інших каналів цей метод не доступний і відповідна помилка буде повернена. |
| Note |
|---|
Вам необхідний ідентифікатор клієнта в месенджері вибраного каналу, щоб у Вас була можливість йому написати. Наприклад, для Telegram Messenger – це має бути Telegram ID, для WhatsApp Messenger – номер телефону клієнта у міжнародному форматі. |