Отправка сообщений
Для отправки сообщений в каналы WhatsApp, Viber, SMS, Push и Notify используется метод api/cascade/schedule
.
Если у вас зарегистрировано два одинаковых по контенту шаблона WhatsApp, которые отличаются только параметром Отслеживать переходы по кнопке-ссылке, мы не рекомендуем отправлять сообщения с таким контентом по API. Для отправки используйте личный кабинет edna Pulse.
В обратном случае мы не можем гарантировать корректное отображение статистики переходов по кнопкам-ссылкам
edna Pulse не позволяет отправлять дубликаты сообщения в течение 20 минут после его отправки
Сообщения отправляются через каскад — сценарий последовательной рассылки в несколько каналов. При регистрации канала каскад для него создается автоматически.
Создать каскад из нескольких каналов можно в личном кабинете edna Pulse.
Как работают каскады Как создать каскадВы можете протестировать отправку сообщений с помощью API edna Pulse для канала WhatsApp, не регистрируя канал
Тестирование API канала WhatsAppВызов метода api/cascade/schedule
Чтобы вызвать метод api/cascade/schedule
, отправьте POST-запрос на URL-адрес https://app.edna.ru/api/cascade/schedule
. Запрос выполняется через публичный интерфейс API с авторизацией по API-ключу.
После выполнения запроса программа получает задание на отправку сообщения по каскаду согласно параметрам в теле запроса.
Если запрос принят, сервер возвращает ответ с кодом 200
, содержащий JSON-объект с идентификатором запроса. В случае неуспешной проверки запроса возвращается ответ с кодом ошибки.
Информация о результате отправки сообщения приходит на установленный вебхук.
Получение статусов сообщенийВ случае успешной отправки сообщения возвращается ст атус sent
, затем delivered
, read
или undelivered
(в зависимости от канала). Статус сообщения failed
означает, что сообщение обработано с ошибкой и не отправлено.
Если сервер не возвращает статус сообщения — отправьте запрос в службу поддержки edna.
Формат запроса
В теле запроса передается набор параметров каскада, по которому вы хотите отправить сообщение
{
"requestId": "string",
"cascadeId": 0,
"subscriberFilter": {
"address": "string",
"type": "EDNA_ID"
},
"startTime": "2023-09-27T12:06:29Z",
"ttl": "PT1M",
"content": {
"smsContent": {
"text": "string"
},
"whatsappContent": {
"contentType": "TEXT",
"text": "string",
"attachment": {
"url": "string",
"name": "string"
},
"location": {
"longitude": 0,
"latitude": 0,
"address": "string",
"name": "string"
},
"comment": "string",
"caption": "string",
"action": "string",
"header": {
"text": "string",
"imageUrl": "string",
"documentUrl": "string",
"documentName": "string",
"videoUrl": "string",
"videoName": "string"
},
"footer": {
"text": "string"
},
"keyboard": {
"rows": [
{
"buttons": [
{
"text": "string",
"url": "string",
"urlPostfix": "string",
"phone": "string",
"payload": "string",
"type": "PHONE",
"otpType": "COPY_CODE",
"color": "string",
"requestContact": true,
"requestLocation": true,
"autofillText": "string",
"packageName": "string",
"hash": "string",
"appId": 0,
"ownerId": 0
}
]
}
]
},
"listPicker": {
"button": "string",
"sections": [
{
"title": "string",
"items": [
{
"identifier": "string",
"title": "string",
"subtitle": "string"
}
]
}
]
},
"catalog": {
"id": "string",
"product": {
"id": "string"
},
"sections": [
{
"title": "string",
"products": [
{
"id": "string"
}
]
}
]
},
"order": {
"catalogId": "string",
"products": [
{
"id": "string",
"quantity": 0,
"price": 0,
"currency": "RUB"
}
]
},
"messageMatcherId": 0
},
"viberContent": {
"contentType": "TEXT",
"text": "string",
"attachment": {
"url": "string",
"name": "string"
},
"location": {
"longitude": 0,
"latitude": 0,
"address": "string"
},
"comment": "string",
"caption": "string",
"action": "string",
"header": {
"text": "string",
"imageUrl": "string",
"documentUrl": "string",
"documentName": "string",
"videoUrl": "string",
"videoName": "string"
},
"footer": {
"text": "string"
},
"keyboard": {
"rows": [
{
"buttons": [
{
"text": "string",
"url": "string",
"urlPostfix": "string",
"phone": "string",
"payload": "string",
"type": "PHONE",
"otpType": "COPY_CODE",
"color": "string",
"requestContact": true,
"requestLocation": true,
"autofillText": "string",
"packageName": "string",
"hash": "string",
"appId": 0,
"ownerId": 0
}
]
}
]
}
},
"pushContent": {
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"small": {
"title": "string",
"text": "string",
"imageUrl": "string"
},
"big": {
"title": "string",
"text": "string",
"imageUrl": "string"
},
"buttons": [
{
"text": "string",
"url": "string"
}
],
"action": "string",
"effects": {
"sound": "string",
"lights": "string",
"vibrate": "string",
"androidNotificationChannel": "string"
},
"iosSettings": {
"interruptionLevel": "ACTIVE",
"category": "string"
},
"subscription": "string"
},
"vkNotifyContent": {
"contentType": "string",
"text": "string",
"messageMatcherId": 0,
"keyboard": {
"rows": [
{
"buttons": [
{
"text": "string",
"buttonType": "QUICK_REPLY",
"payload": "string",
"color": "string"
}
]
}
]
}
},
"okNotifyContent": {
"contentType": "string",
"text": "string"
}
},
"errorIfNotMatched": true,
"comment": "string",
"priority": "default"
}