Регистрация push-устройства

Используйте метод registration, чтобы привязать push-устройство к получателю. Это позволит отправлять push-уведомление по идентификатору получателя и запускать рассылку по каскаду из нескольких каналов.

Перед использованием метода убедитесь, что в настройках push-приложения установлен ручной способ регистрации устройств.

При успешном выполнении запроса от сервера вернется ответ с кодом 200.

URL-адрес подключения

Для использования метода отправьте POST-запрос на адрес: https://app.edna.ru/api/push/device/registration

Параметры запроса

ПараметрТипОписание
subscriberObject
(необязательный)
Получатель сообщения: ID в edna Pulse, номер телефона клиента, а также другие ID для push-сообщений.

subscriberFilter включает в себя следующие параметры:
address  — значение, которое зависит от type.
type  — это PHONEEDNA_ID, а также различные ID для push-сообщений (полный список ID доступен ниже в описании параметра type).

Если type это PHONE, то address будет номер телефона клиента. Например:

«subscriberFilter»:
{
«address»: «79000000000»,
«type»: «PHONE»
}
subscriber.
address
StringЗначение идентификатора указанного типа type.
subscriber.
type
StringТип идентификатора клиента.

Возможные значения (необходимо указывать в верхнем регистре):
• INSTAGRAM_ID* — идентификатор клиента в Instagram*.
• FACEBOOK_ID*.
• PHONE — номер телефона клиента в формате <79000000000>.
• EMAIL.
• UTM.
• COOKIE_ID.
• TELEGRAM_ID.
• GOOGLE_ID.
• APPLE_ID.
• YANDEX_ID.
• EXT_USER_ID.
deviceAppInfo.
deviceAddress
StringУникальный push-адрес устройства пользователя в сервисе edna. Приходит в коллбэке от мобильных push-библиотек edna:
• EDNAPushXDeviceInfo на iOS.
• onDeviceAddressChanged на Android.
Меняется вместе с изменением токенов в push-облаках.
Также используется как DEVICE_APP_ID.
deviceAppInfo.
deviceUID
StringУникальный идентификатор устройства пользователя.
Остается постоянным до переустановки приложения пользователем.
deviceAppInfo.
deviceName
String (необязательный)Имя, установленное пользователем для своего устройства.
deviceAppInfo.
systemName
String
(необязательный)
Название модели устройства пользователя.
deviceAppInfo.
appPackage
StringИмя пакета приложения.
deviceAppInfo.
locale
String (необязательный)Локаль интерфейса устройства пользователя в формате <RU>.
deviceAppInfo.
timezone
String (необязательный)Временная зона, установленная на устройстве пользователя, в формате TZ-идентификатора вида <Europe/Moscow>.
deviceAppInfo.
notificationAlertAllowed
Boolean (необязательный)Разрешение показа уведомлений для приложения.
deviceAppInfo.
notificationDelayedViewEnabled
Boolean (необязательный)Включено ли приложение в сводку уведомлений (только iOS).
deviceAppInfo.
timeSensitiveNotificationAllowed
Boolean (необязательный)Разрешено ли отображение time-sensitive уведомлений (только iOS).

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

{
  "subscriber": {
    "address": "79001002030",
    "type": "PHONE"
  },
  "deviceAppInfo": {
    "deviceAddress": "gcmfptwlc8lv1ahl28hannuesjj98yqodl",
    "deviceUID": "2d9dd0c275bc9a240c00bcd8a46120c53c840f91",
    "deviceName": "test22",
    "systemName": "HUAWEI ANE-LX1",
    "appPackage": "com.edna.e2e.load.saas.e2e.gcm.app1_c6b91927-0d8e-4f43-a507-c3f216c56319",
    "locale": "RU",
    "timezone": "Europe/Moscow",
    "notificationAlertAllowed": true,
    "notificationDelayedViewEnabled": false,
    "timeSensitiveNotificationAllowed": false
  }
}