Channels API
- Oleksandr Serdiuk
- Dmytro Lytvyn
Позволяет просматривать, находить и обновлять каналы внутри Smart Messenger (Подключенные каналы коммуникации).
Чтение.
Позволяет просмотреть подключенные каналы в проекте.
GET https://api.smartsender.com/v1/channels
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
{
"cursor": Cursor,
"collection": Channel[]
}
Описание ответа:
Получение по ID.
Позволяет просмотреть подключенный канал в проекте по идентификатору.
GET https://api.smartsender.com/v1/channels/{channelId}
В случае успешного ответа получите объект типа Channel.
Обновление.
Позволяет изменить активность выбранного канала.
PUT https://api.smartsender.com/v1/channels/{channelId}
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
state | Статус активности | Boolean |
В случае успешного ответа получите следующее:
{
"state": true
}
Создание шлюза.
Позволяет создать шлюз для канала. Если шлюз уже создан с данным идентификатором, будет возвращен уже существующий шлюз. Контакт будет создан автоматически.
POST https://api.smartsender.com/v1/channels/{channelId}/gates
Параметры URL:
Название | Описание | Валидация |
|---|---|---|
channelId | Идентификатор канала | Обязательное, число.
|
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
identifier | Идентификатор клиента в мессенджере. | Обязательное, строка.
|
firstName | Имя клиента | Обязательное, строка, максимальная длина 255 символов |
lastName | Фамилия клиента | Не обязательное, строка, максимальная длина 255 символов |
Емейл клиента | Не обязательное, емейл | |
phone | Телефон клиента | Не обязательное, телефон в международном формате с использованием “+“ |
parameters | Список переменных | Не обязательное, массив ключ-значение с переменными для данного контакта |
В случае успешного ответа получите объект типа Gate.
На данный момент, Вы можете использовать создание шлюза через API исключительно для Whatsapp каналов и в ближайшем времени будет доступно для Viber каналов. Для других каналов, данный метод не доступен и соответствующуя ошибка будет возвращена.
Вам необходим идентификатор клиента в мессенджере выбранного канала что бы у Вас была возможность ему написать. Например, для Telegram Messenger - это должен быть Telegram ID, для WhatsApp Messenger - номер телефона клиента в международном формате.