Подписчики

В этой статье мы опишем, как можно управлять Подписчиками Статус Страниц через API. Подписчики — это пользователи, которые получают уведомления об инцидентах и обновлениях статуса.

Объект Подписчика

GET /v1/pages/{page_id}/subscribers
GET /v1/pages/{page_id}/subscribers/{subscriber_id}

Метод для получения всех подписчиков указанной Статус Страницы или одного подписчика по ID.

Пример объекта подписчика (адрес электронной почты скрыт):

{
  "created_at": "2025-04-30T18:56:23.173365",
  "deliver_notifications": true,
  "display_at": null,
  "display_phone_number": null,
  "email": "a*****@yandex.ru",
  "endpoint": null,
  "has_pending_verification": false,
  "id": "la8o10iu2d3x",
  "is_verified": true,
  "mode": "email",
  "obfuscated_channel_name": null,
  "page_access_user_id": null,
  "page_id": "5rs9dvpvyyp8",
  "phone_country": null,
  "phone_number": null,
  "purge_at": null,
  "quarantined_at": null,
  "skip_confirmation_notification": true,
  "updated_at": "2025-04-30T18:57:13.622693",
  "workspace_name": null
}

Поля

Поле	Тип объекта	Описание
created_at	string (ISO 8601)	Дата и время создания подписки.
deliver_notifications	boolean	Указывает, будет ли подписчик получать уведомления.
display_at	string or null	Дата и время, когда подписка станет активной (если задано).
display_phone_number	string or null	Отображаемый номер телефона подписчика (может быть частично скрыт).
email	string or null	Адрес электронной почты подписчика (может быть частично скрыт в целях безопасности).
endpoint	string or null	URL-адрес для push-уведомлений (если используется этот метод).
has_pending_verification	boolean	Указывает, находится ли подписка в процессе верификации.
id	string	Уникальный идентификатор подписчика.
is_verified	boolean	Указывает, верифицирована ли подписка.
mode	string	Способ подписки (email, sms, webhook).
obfuscated_channel_name	string or null	Скрытое имя канала подписки (например, часть email или номера телефона).
page_access_user_id	string or null	ID пользователя, предоставившего доступ к странице (если применимо).
page_id	string	ID Статус Страницы, на которую подписан пользователь.
phone_country	string or null	Код страны номера телефона подписчика (если используется SMS).
phone_number	string or null	Номер телефона подписчика (может быть частично скрыт).
purge_at	string or null	Дата и время, когда подписка будет удалена (если задано).
quarantined_at	string or null	Дата и время, когда подписка была помещена в карантин из-за проблем с доставкой уведомлений.
skip_confirmation_notification	boolean	Указывает, следует ли пропускать отправку подтверждающего уведомления при подписке.
updated_at	string (ISO 8601)	Дата и время последнего обновления подписки.
workspace_name	string or null	Название рабочего пространства  Slack, к которому принадлежит подписчик (если применимо).

Создание Подписчика

POST /v1/pages/{page_id}/subscribers

Этот endpoint доступен без авторизации. Любой пользователь может подписаться на обновления, если это разрешено настройками Статус Страницы.

Требуемые поля

В зависимости от способа подписки (mode), требуются различные поля:

Поле	Тип объекта	Описание
email	string	Адрес электронной почты.
mode	string	Способ подписки - email, webhook, sms

Пример подписки по email

curl -X POST \
  -H "Content-Type: application/json" \
  https://api.pingera.ru/v1/pages/{page_id}/subscribers \
  -d '{
    "mode": "email",
    "email": "new.subscriber@example.com"
  }'