iSpring Port

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

GET  /webhook/subscriber/info

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

Заголовок

Описание

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

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

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

curl --location 'https://api-learn.ispringlearn.ru/webhook/subscriber/info?subscriberName=subscriberName' \
--header 'X-Auth-Account-Url: https://myaccount.ispring.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 — события отправляются.
  2. Inactive — события не отправляются.
  3. Suspended — доставить события не удалось, поэтому отправка ожидает повторной попытки. Во время ожидания события будут копиться и не будут потеряны. Если сервис пользователя станет доступен, то он получит все накопленные сообщения, а статус отправки снова станет active.

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

{
    "subscriberStatus": "ACTIVE",
    "confirmationStatus": "CONFIRMED",
    "notificationProcessStatus": "ACTIVE"
}

Коды ответов

Код

Текст

Описание

200

ОК

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

400

Bad Request

Ошибка в запросе.

401

Unauthorized

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

403

Permission Denied

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

404

Subscriber not found

Подписчик не найден.

  • Нет меток