Notifications API

Статус документа

Оглавление

Методы

Методы принимают только JSON формат сообщений.

Возвращаемые ошибки

Ошибки возвращаются с помощью HTTP кодов состояния ответов и могут быть следующими:

На данный момент ни один метод не возвращает никакой информации за исключением кода состояния.

sendNotification — отправить уведомление

Отправить уведомление заданного типа.

Параметры: сообщение SendNotification (кодируется в JSON и отправляется методом POST).

Формат ответа: пусто.

Дополнительный код ошибки: при отправке данного сообщения одному и тому же адресату и/или с одного и того же IP–адреса слишком часто (чаще 1 чем раз в 1 минуту) API возвращает код ошибки 403 Spam detected.

Описание сообщений

SendNotification — Отправка уведомления

message SendNotification {
  enum DeliverySystem {
    EMAIL = 0;
  }

  message DestinationAddress {
    optional string address = 1; 
  }

  enum NotificationType {
    CHILD_PEERS_LOST_PASSWORD = 0;
  }

  required DeliverySystem deliverySystem = 1;
  required NotificationType type = 2;
  repeated DestinationAddress addresses = 3;

  extension 100 to 199;
}

Замечания:

• DeliverySystem — отвечает за способ доставки уведомления до пользователя. На данный момент доступна только отправка электронной почты. В дальнейшем возможна реализация отправки SMS–сообщений или прямое воздействие на мозг пользователя.
• NotificationType — отвечает за само уведомление. Для каждого типа уведомления и его способа доставки подразумевается различная реакция: текста в электронной почте может быть значительно больше, чем в SMS–сообщении.
• DestinationAddress — адресат сообщения. Зависит от значения DeliverySystem.

Расширения

Забытый пароль в «Детском Пирсе»

extend SendNotification {
  message ChildPeersLostPassword {
    required string password = 1;
  }

  optional ChildPeersLostPassword childPeersLostPassword = 100;
}

Замечания:

• type == CHILD_PEERS_LOST_PASSWORD (0)
• childPeersLostPassword.password — действующий пароль в Детском Пирсе.