Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

GET  /webhook/subscriber/info

Пример запроса:

...

Заголовки запроса 

Заголовок

Описание

X-Auth-Account-UrlURL-адрес аккаунта, например: https://myaccount.ispringlearn.ru
X-Auth-Email (required)Логин владельца аккаунта и администратора аккаунта.
X-Auth-Password (required)

Пароль владельца аккаунта и администратора аккаунта.

Пример запроса

Блок кода
languagexml
curl --location 'https://api-learn.ispringlearn.ru/webhook/subscriber/info?subscriberName=subscriberName' \

...


--header 'X-Auth-Account-Url: https://myaccount.ispringlearn.ru' \

...


--header 'X-Auth-Email: email@email.com' \

...


--header 'X-Auth-Password: password' \

...


--header 'Accept: application/json'

В ответ на запрос приходит:

...

Параметры ответа

ПараметрОписание
subscriberStatusСтатус включенности подписчика: active / inactive

...

confirmationStatusСтатус подтверждения URL: confirmed / unconfirmed

...

notificationProcessStatus

...

Статус процесса отправки сообщений:

...

  1. Active — события отправляются.

...

  1. Inactive — события не отправляются.

...

  1. Suspended — доставить события не удалось, поэтому отправка ожидает повторной попытки. Во время ожидания события будут копиться и не будут потеряны. Если сервис пользователя станет доступен, то он получит все накопленные сообщения, а статус отправки снова станет active.

Пример ответа

...

Блок кода
languagexml
{
    

...

{

...

"subscriberStatus": "ACTIVE",

...


    "confirmationStatus": "CONFIRMED",

...


    "notificationProcessStatus": "ACTIVE"

...


}

Коды ответов

...

Код

Текст

Описание

200

ОК

Ответ на запрос получен.

400

Bad Request

Ошибка в

запросе 

запросе.

401

Unauthorized

Ошибка авторизации.

403

Permission Denied

У пользователя нет прав.

404

Subscriber not found

Подписчик не

найден 

найден.