--> --> --> -->

Установка URL-адресов для callback-запросов

API-метод set устанавливает URL-адреса, на которые edna Pulse будет отправлять callback-запросы.

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

Метод set принимает только POST запросы. Параметры передаются в теле запроса в виде JSON-объекта. Для авторизации используется API-ключ. После регистрации в edna Pulse вы можете сгенерировать или скопировать имеющийся ключ самостоятельно. Дополнительную информацию про настройку API смотрите в статье.

Вы можете включить авторизацию callback-запросов, которые edna Pulse передает на ваш сервер.

Метод set

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

Если в ответ на callback-запрос не приходит код 200, программа edna Pulse выполняет еще 10 попыток запроса с интервалом 2*Х секунд между попытками (где Х — номер попытки), пока в ответ не придет код 200. То есть каждые 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048 секунд.

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

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

В теле запроса передается JSON-объект с параметрами.

{
    "statusCallbackUrl": "https://messagesxxx.com/status/webhook",
    "inMessageCallbackUrl": "https://messagesxxx.com/messages/webhook",
    "subjectId": 234
}

Таблица параметров

ПараметрТип данныхОписание
statusCallbackUrlstring (optional)URL коллбека для получения статусов доставки сообщений. Максимум 500 символов.
ВАЖНО! Адрес должен существовать и быть доступным для запроса из публичного интернета. Для проверки доступности мы пошлем HEAD запрос, на который ожидаем увидеть ответ со статусом 200. В противном случае мы не сможем зарегистрировать ваш URL.
inMessageCallbackUrlstring (optional)URL коллбека для получения входящих сообщений. Максимум 500 символов.
ВАЖНО! Адрес должен существовать и быть доступным для запроса из публичного интернета. Для проверки доступности мы пошлем HEAD запрос, на который ожидаем увидеть ответ со статусом 200. В противном случае мы не сможем зарегистрировать ваш URL.
messageMatcherCallbackUrlstring (optional)URL коллбека для получения событий по управлению (например, регистрации шаблона).
ВАЖНО! Адрес должен существовать и быть доступным для запроса из публичного интернета. Для проверки доступности мы пошлем HEAD запрос, на который ожидаем увидеть ответ со статусом 200. В противном случае мы не сможем зарегистрировать ваш URL.
subjectIdinteger (optional)Идентификатор канала. Его можно узнать через метод получения списка каналов.
Если в запросе не указан параметр subjectId, то коллбеки устанавливаются для всех каналов тенанты. В случае, если в запросе указан subjectId, то значение адреса коллбека устанавливается только для указанного канала.

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

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

ПараметрТип данныхОписание
codestringКод ответа на запрос

Коды ответов на запрос

КодОписание
okЗапрос успешно выполнен.
error-callback-url-max-lengthURL содержит более 500 символов.
error-callback-url-not-httpsURL не использует https.
error-callback-url-not-availableЗапрос HEAD по URL завершился с ошибкой.
error-subject-unknownНе найден канал с указанным идентификатором.
url-not-specifiedНеобходимо указать StatusCallbackUrl или inMessageCallbackUrl.