«Коммуникационная платформа SevenTech» - Руководство по эксплуатации: интеграция по API
- «Коммуникационная платформа SevenTech» - Руководство по эксплуатации: интеграция по API
- 1. Авторизация
- 2. Метод отправки сообщения
- 3. Возврат статуса (callback)
- 4. Передача входящих сообщений (incoming)
1. Авторизация
Есть возможность настроить авторизацию двумя способами:
- Для подключения используется тип авторизации Basic Auth, для организации доступа клиент получает пару логин и пароль и вводит запрашиваемые значения в соответствующие поля:
Authorization: Basic Auth
Username: username
Password: password
- При подключении клиент получает пару логин и пароль, которые требуются для авторизации, для чего необходимо закодировать пару
логин:пароль
алгоритмом Base64 и передать в виде заголовкаAuthorization
HTTP-запроса или через query-параметр
Пример закодированного заголовка HTTP Basic Authentication:
Authorization: Basic YWhhbWlsdG9uQGFwaWdlZS5jb206bXlwYXNzdzByZAo
2. Метод отправки сообщения
POST https://my.seven.tech/messaging/v1/send
2.1 Параметры
Параметры описываются в формате JSON и могут иметь один или несколько базовых элементов scenario.
Name | Type | Description |
---|---|---|
scenario required | scenario | Массив элементов описывающий процесс передачи сообщения (структура описана отдельно) |
callback optional | string | URI для отправки отчета о доставке. |
clientRequestId optional | string | Идентификатор клиентского запроса, максимальная длина 100 символов |
urlOptions optional | object | Параметры сокращения ссылок в сообщении. Для включения такой возможности нужно обратиться к вашему менеджеру. |
trackData optional | object | Набор параметров, которые будут возвращены в callback , пример: "trackData": { "tag": "12345678" }, |
2.1.1 scenario — сценарий отправки сообщения
Name | Type | Description |
---|---|---|
channel required | enum | Канал отправки. Значения: sms - отправка сообщения посредством SMS viber - отправка сообщения в месссенджер Viber vkok - отправка сообщения чере з соцсети VK и OK (в зависимости от активности абонента в той или иной соцсети) push - отправка сообщения посредством Push нотификации на iOS/Android whatsapp - отправка сообщения в месссенджер WhatsApp tgotp - отправка кодов авторизации в мессенджер Telegram Каналы подключаются по согласованию с менеджером |
recipient required | recipient | Получатель сообщения (структура описана отдельно) |
sender required | string | Имя отправителя. Для канала sms максимальная длина 11 символов, для других каналов - 21. |
text optional | string | Текст сообщения. Максимальная длина ограничена 39015 байтами (255 частей), что соответствует 39015 символам ASCII, 19507 символам не ASCII. Наличие emoji в тексте сокращает это значение, так как emoji занимает от 2 до 4 байт |
failover optional | object | Стратегия отправки сообщения по альтернативному каналу (структура описана отдельно) |
attachments optional | attachments | Вложения сообщения (структура описана отдельно) |
buttons optional | buttons | Кнопка сообщения (структура описана отдельно) |
mobilePushAction optional | string | DeepLink при нажатии на push сообщение, используется только для канала push |
mobilePushTitle optional | string | Title для push сообщения, используется только для канала push |
2.1.1.1 recipient — получатель сообщения
Name | Type | Description |
---|---|---|
type required | enum | Тип получателя. Значения: MSISDN - номер абонента в формате [E.164] (https://en.wikipedia.org/wiki/E.164) |
value required | string maxLength: 200 | Значение адреса получателя |
2.1.1.2 attachments — медиаконтент сообщения
Name | Type | Description |
---|---|---|
type required | enum | Тип контента. Значения: IMAGE — изображение AUDIO — аудио файл VIDEO – видео файл FILE — файл |
url required | string | Ссылка на медиаконтент |
2.1.1.3 buttons — кнопка сообщения
Name | Type | Description |
---|---|---|
caption required | string | Текст кнопки |
action required | string | Ссылка, которая откроется, при нажатии на кнопку |