Установка колбека

Раздел содержит описание метода API для установки значения колбека.

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

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

Метод set

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

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.
subjectIdinteger (optional)Идентификатор канала. Его можно узнать через метод получения списка каналов
ВНИМАНИЕ! Если в запросе не указан параметр subjectId, то коллбеки устанавливаются для всех каналов тенанты. В случае, если в запросе указан subjectId, то значение адреса коллбека устанавливается только для указанного канала.

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

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

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

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

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

Получение событий для вызова авторассылки