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

Обновлено: 15 апреля 2022

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

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

Управление API-ключами для интеграции с API edna Pulse Управление вебхуками edna Pulse

к сведению

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

Вызов метода

Отправьте POST-запрос на URL-адрес https://app.edna.ru/api/callback/set.

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

Если в ответ на callback-запрос не возвращается статус с кодом 200 — edna Pulse выполняет еще 10 попыток отправки вебхук-запроса с интервалом 2^Х секунд между попытками (где Х — номер попытки), пока в ответ не придет код 200.

подсказка

Таким образом, при отсутствии ответа запрос повторяется через 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048 секунд после первой попытки.

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

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

Параметры запроса

к сведению

URL, указываемый в параметрах statusCallbackUrl, inMessageCallbackUrl и messageMatcherCallbackUrl должен существовать и быть доступным для запроса из публичного интернета. Для проверки доступности мы пошлем HEAD запрос, на который ожидаем увидеть ответ со статусом 200.

В противном случае мы не сможем зарегистрировать ваш URL.

Параметр	Тип	Описание
statusCallbackUrl	string (optional)	URL коллбека для получения статусов доставки сообщений. Максимум 500 символов.
inMessageCallbackUrl	string (optional)	URL коллбека для получения входящих сообщений. Максимум 500 символов.
messageMatcherCallbackUrl	string (optional)	URL коллбека для получения событий по управлению (например, регистрации шаблона).
subjectId	integer (optional)	Идентификатор канала. Его можно узнать через метод получения списка каналов. Получение списка каналов

warning

Если в запросе не указан параметр subjectId, то коллбеки устанавливаются для всех каналов тенанты.

В случае, если в запросе указан subjectId, то значение адреса коллбека устанавливается только для указанного канала.

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

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

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

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

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