Отправка сообщений

Раздел содержит описание методов, входящих в API: примеры запроса/ответа, а также описание параметров запроса и атрибутов ответа. Для каждого параметра указан тип значения и краткое описание.

Работа с публичным API доступна для всех клиентов, зарегистрированных на портале edna. Настроить доступ и получить API-ключ можно в Личном кабинете портала edna.

API принимает только POST запросы. Параметры передаются в теле запроса в виде JSON-объектов. В ответ — если это предусмотрено конкретным запросом — также возвращаются JSON-объекты. API использует авторизацию с помощью API-ключа. При выполнении запросов они должны содержать заголовок X-API-KEY, значением которого должен быть API-ключ клиента. Ключ вам будет передан вместе с учетными данными после регистрации в https://app.edna.ru/.

Метод schedule

В результате выполнения запроса будет отправлено сообщение в мессенджер в соответствии с заданными параметрами (в теле запроса). В случае успешного выполнения запроса вернется ответ от сервера с кодом 200, содержащий JSON с идентификатором сообщения и статусом его отправки. В случае неуспешного выполнения запроса возвращается сообщение с кодом ошибки.

URL-адрес подключения

Для отправки сообщения выполняется POST-запрос на URL-адрес: https://app.edna.io/api/cascade/schedule

Формат запроса

В теле запроса передается JSON-объект с параметрами сообщения. Набор параметров зависит от типа сообщения и его содержимого: текст, изображение, документ, аудио или видео.

Ниже приведен общий набор параметров для различных типов контента. Более подробно о назначении параметров указано в таблицах и приведены примеры их использования ниже.

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "smsContent": {
            "text": "Some sms message"
        },
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Some whatsapp message",
            "attachement": {
                "url": "https://wa.edna.io/img/hjalsdnasd.jpg",
                "name": "Pretty image",
                "size": 5123
            },
            "location": {
                "longitude": 56.7645,
                "latitude": 48.4564,
                "address": "Sahara desert"
            },
            "comment": "some comment",
            "caption": "some caption",
            "action": "some action",
            "header": {
                "documentUrl": "https://edna.io/docs/bjaksnda.pdf",
                "documentName": "bjaksnda.pdf"
            },
            "footer": {
                "text": "Some footer"
            },
            "keyboard": {
                "rows": [
                    {
                        "buttons": [
                            {
                                "text": "some button"
                            },
                            {
                                "url": "https://example.com"
                            }
                        ]
                    }
                ]
            }
        }

Таблица

ПараметрТип данныхОписание
requestIdstringИдентификатор сообщения. Генерируется вашей системой, после чего значение должно быть передано в запрос. Допускается любая длинна строки до 36 символов
cascadeIdstringИдентификатор каскада.
При создание канала автоматически создается каскад с отправкой сообщения по этому каналу. Для того, чтобы узнать идентификатор нужного вам каскада, используйте метод API по получению информации о каскадах (см поле id).
subscriberFilterstringПолучатель сообщения: ID в Платформе edna, номер абонента или ID клиента в Instagram

subscriberFilter включает в себя следующие параметры: address и type. В свою очередь, type может быть id, phone, instagramId, при этом address — это значение, которое зависит от type. Таким образом, например, если type это phone, то address будет номер телефона клиента. Пример:

"subscriberFilter":
{
"address": "79000000000",
"type": "phone"
},
addressstringЗначение, которое зависит от указанного type
typestringТип идентификатора клиента: idphone, или instagramId
idstringИдентификатор клиента в базе данных edna, который создаётся автоматически при создании клиента в edna. Отображается на странице Редактирование пользователя в строке URL, например: 3314 в строке https://app.edna.ru/audience/3314/edit
phonestringНомер телефона клиента
intstagramIdstringИдентификатор клиента в Instagram, состоящий из 16 числовых символов. Этот идентификатор создаётся на стороне Facebook, когда клиент первым взаимодействует с Instagram аккаунтом бизнеса. Это значение может быть разным и меняться для одного и того же Instagram клиента
startTimestring (optional)Время, раньше которого сообщение не будет отправлено. Используется при отложенной отправке. Формат YYYY-MM-DDTHH:mm:ss.SSSXXX (2021-01-21T08:00:00Z) or YYYY-MM-DDTHH:mm:ss.SSS+TZ (2021-01-21T08:00:00Z+03:00)
contentobject Объект. Может содержать объекты smsContent, whatsappContent, viberContent
smsContentobject (optional)В объекте передаются данные SMS-сообщений
whatsappContentobject (optional)В объекте передаются данные Whatsapp-сообщений
viberContentobject (optional)В объекте передаются данные Viber-сообщений
instagramContentobject (optional)В объекте передаются данные Instagram-сообщений
contentTypestringТип содержимого сообщения. Возможные значения (нужно указывать в верхнем регистре):
TEXT- текстовое сообщение
IMAGE — изображение
DOCUMENT- документ, вложенный в сообщение
VIDEO — сообщение, содержащее видео
AUDIO — сообщение, содержащее звук
BUTTON — кнопка
LOCATION — сообщение с координатами, адресом и описанием места. Координаты преобразуются в снимок Google maps
commentstring (optional)Текстовый комментарий в сообщении. Значение параметра отображается в детальном отчете.
textstring
(optional)
Текст сообщения
attachmentobject (optional)Содержит информацию о вложении
attachment.urlstringСсылка на картинку или файл/видео/audio
attachment.namestringНазвание картинки или файла/видео/audio
locationobject (optional)Содержит информацию о местонахождении
location.longitudestringКоординаты
location.latitudestringКоординаты
location.addressstringАдрес на карте
headerobject (optional)Заголовок сообщения. Можно выбрать один из следующих вариантов заголовка: текст, изображение, документ. Для текстового заголовка нужно указать сам текст заголовка, заголовок может содержать одну переменную. Сам заголовок отображается жирным текстом перед сообщением. Для мультимедиа заголовка можно указать ссылку на документ или изображение
footerobject (optional)Подпись. Отображается под сообщением приглушенным цветом текста
buttonsobject (optional)Массив объектов, в каждом из которых определяется кнопка. Виды кнопок: Текст, Ссылка, Телефон, Payload — возвращает входящее сообщение. См. примеры
captionstring (optional)Только для Viber. Название кнопки
actionstring (optional)Только для Viber. Ссылка для кнопки

Требования к оформлению текста

Важно! Необходимо быть внимательным к выделению слов в кавычки. Если вы используете знак двойные кавычки “ или одиночные кавычки ‘ в отправляемом сообщении, то их обязательно нужно отделять знаком \ (обратный слеш).

Правильно:

"text": "Мария! Ждем вас на Мастер-класс \"Готовим вместе c Tefal\" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"
и так
"text": "Мария! Ждем вас на Мастер-класс «Готовим вместе c Tefal» 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"

Неправильный

"text": "Мария! Ждем вас на Мастер-класс "Готовим вместе с Tefal" 25.01.2020 в 13.00. Не пропустите это событие! Наш телефон 8(495)100-00-00"

Формат ответа

В ответ на запрос возвращается JSON-объект, содержащий Id отправленного сообщения и статус его обработки.

ПараметрТип данныхОписание
idstringИдентификатор сообщения. Это номер был сгенерирован на вашей стороне
codestringКод ответа для данного сообщения. Возможные значения

Типы вложений

Все отправляемые вложения должны удовлетворять нижеперечисленным требованиям. Иначе сообщение не будет доставлено.


Поддерживаемые типы медиа вложений:

Тип вложенияПоддерживаемый формат
documentЛюбой корректный MIME тип
imageimage/jpeg, image/png
audioaudio/aac, audio/mp4, audio/amr, audio/mpeg, audio/ogg; Кодек=opus (NWB) и ACC
videovideo/mp4, video/3gpp Внимание: Поддерживается только формат MPEG 4 и 3GPP c кодеком H.264 (MPEG-4 Part 10) и AAC для аудио

Допустимые размеры вложений:

Тип вложенияРазмер, MB
document100
image5
audio16
video16

Важно! Название прикрепленного файла (attachmentName) не может превышать 25 символов для месенджера Viber. Для все остальных допускается не более 75 символов

Для дополнительной информации по форматам медиа вложений для whatsapp можно
обратиться на ресурс: https://developers.facebook.com/docs/whatsapp/api/media/#supported-files

Примеры

SMS-сообщение

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "smsContent": {
            "contentType": "TEXT",
            "text": "Добрый день! Дмитрий"
        }
    }
}

Whatsapp чат-сообщение

Текст

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Добрый день! Рады представить Вам наш новый канал взаимодействия с клиентами. Здесь вы можете задавать все интересующие вас вопросы."
        }
    }
}

Картинка

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "IMAGE",
            "attachment": {
                "url": "https://www.gstatic.com/webp/gallery/1.jpg",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Документ

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "DOCUMENT",
            "attachment": {
                "url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Видео

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "VIDEO",
            "attachment": {
                "url": "https://file-examples.com/wp-content/uploads/2017/04/file_example_MP4_480_1_5MG.mp4",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Аудио

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "AUDIO",
            "attachment": {
                "url": "https://dl.espressif.com/dl/audio/ff-16b-2c-44100hz.aac",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Геолокация

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "LOCATION",
            "location": {
                "longitude": "163",
                "latitude": "48",
                "address": "г. Москва, ул Правды, д 3"
            }
        }
    }
}

С интерактивным меню

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "LIST_PICKER",
            "text": "Здравствуйте, пожалуйста, выберите, какого цвета худи вы хотите",
            "listPicker": {
                "button": "Цвета худи",
                "sections": [
                    {
                        "title": "Выберите цвет",
                        "items": [
                            {
                                "identifier": "1",
                                "title": "Red",
                                "subtitle": "Худи Матрица L красная"
                            },
                            {
                                "identifier": "2",
                                "title": "Blue",
                                "subtitle": "Худи Матрица L синяя"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

С кнопками ответа

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Здравствуйте, пожалуйста, выберите, какого цвета худи вы хотите",
            "keyboard": {
                "rows": [
                    {
                        "buttons": [
                            {
                                "text": "Красный",
                                "payload": "1"
                            },
                            {
                                "text": "Синий",
                                "payload": "2"
                            },
                            {
                                "text": "зелёный",
                                "payload": "3"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Whatsapp HSM-сообщение

Текст и подпись

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "footer": {
                "text": "Спасибо за интерес"
            }
        }
    }
}

Текст, заголовок-текст и подпись

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "header": {
                "text": "Ваш чат с edna"
            },
            "footer": {
                "text": "Спасибо за интерес"
            }
        }
    }
}

Текст и заголовок-картинка

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "header": {
                "imageUrl": "https://cdn.maikoapp.com/3d4b/4qgko/200.jpg"
            }
        }
    }
}

Текст и заголовок-картинка и подпись

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Текст и заголовок-картинка и подпись",
            "header": {
                "imageUrl": "https://www.gstatic.com/webp/gallery/1.jpg"
            },
            "footer": {
                "text": "Ждем вас!"
            }
        }
    }
}

Текст и заголовок-файл 

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "header": {
                "documentUrl": "https://cdn.maikoapp.com/3d4b/4qgko/200.jpg"
            }
        }
    }
}

Текст и заголовок-файл и подпись

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "header": {
                "documentUrl": "https://cdn.maikoapp.com/3d4b/4qgko/200.jpg"
            },
            "footer": {
                "text": "Спасибо за интерес"
            }
        }
    }
}

Текст и заголовок-видео и подпись

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Текст и заголовок-видео и подпись",
            "header": {
                "videoUrl": "https://file-examples.com/wp-content/uploads/2017/04/file_example_MP4_480_1_5MG.mp4"
            },
            "footer": {
                "text": "Ждем вас!"
            }
        }
    }
}

Текст и 2 чат-кнопки

{
    "requestId": "test-001",
    "cascadeId": "11",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "keyboard": {
                "row": {
                    "buttons": [
                        {
                            "text": "Привет!",
                            "buttonType": "QUICK_REPLY",
                            "payload": "1"
                        },
                        {
                            "text": "Пока",
                            "buttonType": "QUICK_REPLY",
                            "payload": "2"
                        }
                    ]
                }
            }
        }
    }
}

Текст и кнопку-ссылку

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "keyboard": {
                "row": {
                    "buttons": [
                        {
                            "text": "Нажимай!",
                            "buttonType": "URL",
                            "url": "https://raskladki.net.ru/ru/"
                        }
                    ]
                }
            }
        }
    }
}

Текст и кнопку-звонок

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Приветствуем! Напишите нам, чтобы познакомиться с функциями edna",
            "keyboard": {
                "row": {
                    "buttons": [
                        {
                            "text": "Звони!",
                            "buttonType": "PHONE",
                            "url": "79000000000"
                        }
                    ]
                }
            }
        }
    }
}

Viber-сообщения

Текст

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "viberContent": {
            "contentType": "TEXT",
            "text": "Новый текст совершенно"
        }
    }
}

Картинка

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "viberContent": {
            "contentType": "IMAGE",
            "attachment": {
                "url": "https://www.gstatic.com/webp/gallery/1.jpg",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Документ

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "viberContent": {
            "contentType": "DOCUMENT",
            "attachment": {
                "url": "https://www.gstatic.com/webp/gallery/1.jpg",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Сообщение с кнопкой и картинкой

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "viberContent": {
            "caption": "Название кнопки",
            "action": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
            "text": "Текст сообщения",
            "contentType": "BUTTON",
            "attachment": {
                "url": "https://www.gstatic.com/webp/gallery/1.jpg",
                "name": "Lorem Ipsum"
            }
        }
    }
}

Отправка SMS-сообщение с резервированием Viber-сообщением

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "79000000000",
        "type": "phone"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "smsContent": {
            "contentType": "TEXT",
            "text": "Новый текст SMS"
        },
        "viberContent": {
            "contentType": "TEXT",
            "text": "Новый текст VIBER"
        }
    }
}

Сообщения в Instagram Messenger

Текст

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "4000000000000000",
        "type": "instagramId"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "instagramContent": {
            "contentType": "TEXT",
            "text": "Instagram text"
        }
    }
}

Картинка

{
    "requestId": "test-001",
    "cascadeId": "1",
    "subscriberFilter": {
        "address": "4000000000000000",
        "type": "instagramId"
    },
    "startTime": "2021-01-21T08:00:00Z",
    "content": {
        "instagramContent": {
            "contentType": "IMAGE",
            "attachment": {
                "url": "https://edna.ru/wp-content/uploads/2020/12/chat-czentr-480x480.jpg",
                "name": "Instagram IMAGE"
            }
        }
    }
}

Ошибки при отправке сообщения

Код 400:

«RequestId is not unique»
Идентификатор запроса использовался ранее. Для каждого запроса используйте новый идентификатор.

«Content not specified»
Не указан контент. Укажите тип контента и все его свойства (например, smsContent/viberContent/whatsapp) Content.

«ContentType not specified»
Не задан тип контента. Например, TEXT или IMAGE.

«Text not specified»
Текстовое поле не заполнено.

«Caption not specified»
Текстовое поле подписи не заполнено.

«Action not specified»
Действие для кнопки не задано.

«AttachmentName not specified»
Имя прикрепляемого документа не задано.

«AttachmentName is too long»
Имя прикрепляемого документа слишком длинное.

«Latitude not specified»
При указании координат не была задана Широта.

«Longitude not specified»
При указании координат не была задана Долгота.

«Cascade not found»
Идентификатор каскада указан не верно. Запросите список всех каскадов вашего аккаунта и проверьте корректность указанного вами идентификатора.

«Request doesn’t contain content for all cascade stages»
Каскад содержит большее количество каналов. Добавьте еще один канал в объект content запроса.

«Matched template not found»
Схема тела запроса не соответствует схеме шаблона. Проверьте взаимное расположение и наличие всех свойств запроса.

Код 401:
«Auth error»
Ошибка авторизации. Проверьте правильность написания и срок действия ключа API.

Код 405:
«Method not allowed»
Метод http запроса не разрешен. Используйте POST,GET и другие запросы в соответствии с документацией.

Код 500:
«System error»

Ошибка сервера. Сообщите о ней в техническую поддержку.
Может возникать при некорректном запросе.
Проверьте взаимное расположение, наличие и заполненность всех свойств запроса в соответствии с документацией.

Список кодов ошибок может быть расширен. Пожалуйста, предусмотрите это при настройке интеграции

Получение статусов сообщений

Callback-функция для передачи информации об изменении статуса доставки сообщения

Запрос который передает на ваш сервер информацию об изменении статуса доставки сообщения. Параметры запроса передаются в теле запроса.

URL-адрес подключения

Для получения Callback-статусов сообщений при регистрации укажите API-endpoint вашей системы, который будет обрабатывать входящие POST запросы от API-edna. Внимание, поддерживается только протокол HTTPS

Пример тела входящего POST запроса.

[
    {
        "requestId": null,
        "cascadeId": 1,
        "cascadeStageUUID": "001-test001",
        "subject": "test_subject",
        "status": "FAILED",
        "statusAt": "2021-01-21T08:00:00Z",
        "error": "error-subject-unknown"
    }
]

Формат запроса

ПараметрТип данныхОписание
requestIdStringИдентификатор сообщения
cascadeIdLongИдентификатор каскада
cascadeStageUUIDStringnull или данные
subjectStringПодпись
statusStringСтатус
statusAtStringВремя последнего обновления статуса сообщения. Указывается формате ISO 8601. Например, 2021-01-21T08:00:00Z
errorString
(optional)
null или данные
Ошибка, возникшая при доставке сообщения Available status codes

Формат ответа

В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.

Статусы доставки

cancelled — отправка сообщения отменена

delivered — сообщение доставлено адресату

delayed — отправка сообщения отложена

enqueued — сообщение находится в очереди на отправку

expired — сообщение не получило статус delivered за период указанный в сообщении, либо не получило статус delivered в течении 24 часов с момента отправки

failed — сообщение не было отправлено в результат сбоя

no-match-template — сообщение не соответствует допустимому шаблону

read — сообщение прочитано адресатом

sent — сообщение отправлено адресату

undelivered — сообщение отправлено, но не доставлено адресату

error-subject-unknown — указанная подпись не разрешена клиенту.Необходимо предварительно зарегистрировать все подписи

error-address-format – неправильный формат номера абонента

Список может быть расширен. Требуется учесть это при интеграции

Cледующая статья Получение сообщений