--> --> --> -->

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

Для привязки пуш-устройства к получателю используется метод api/push/device/registration. Он позволяет отправлять пуш-уведомления по идентификатору получателя и запускать каскадные рассылки из нескольких каналов.

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

Вызов метода api/push/device/registration

Чтобы вызвать метод api/push/device/registration, отправьте POST-запрос на URL-адрес https://app.edna.ru/api/push/device/registration.

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

Формат тела запроса

{
    "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
    }
}

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

ПараметрТип данныхХарактерОписание
subscriberobjectНеобязательныйПолучатель сообщения. Может включать идентификатор получателя в edna Pulse, номер телефона получателя или другие необходимые идентификаторы.
subscriber.
address
stringОбязательныйЗначение типа идентификатора, указанного в параметре type.

Например, если в параметре type указано PHONE, то в параметре address будет номер телефона клиента.
subscriber.
type
stringОбязательныйТип идентификатора получателя. Значения указываются в верхнем регистре.

Возможные значения:
• INSTAGRAM_ID*
• FACEBOOK_ID*
• PHONE
• EMAIL
• UTM
• COOKIE_ID
• TELEGRAM_ID
• GOOGLE_ID
• APPLE_ID
• YANDEX_ID
• EXT_USER_ID
deviceAppInfoobjectНеобязательныйДанные устройства пользователя.
deviceAppInfo.
deviceAddress
stringОбязательныйУникальный пуш-адрес устройства пользователя edna Pulse.

Приходит в колбэке от мобильных пуш-библиотек edna Pulse:
• EDNAPushXDeviceInfo — для iOS.
• onDeviceAddressChanged — для Android.

Меняется вместе с изменением токенов в пуш-облаках.

Также используется как DEVICE_APP_ID.
deviceAppInfo.
deviceUID
stringОбязательныйУникальный идентификатор устройства пользователя.

Остается постоянным до переустановки приложения пользователем.
deviceAppInfo.
deviceName
stringНеобязательныйИмя устройства, установленное пользователем.
deviceAppInfo.
systemName
stringНеобязательныйНазвание модели устройства пользователя.
deviceAppInfo.
appPackage
stringОбязательныйИмя пакета приложения.
deviceAppInfo.
locale
stringНеобязательныйЯзык интерфейса на устройстве пользователя.

Пример формата — RU.
deviceAppInfo.
timezone
stringНеобязательныйВременная зона, установленная на устройстве пользователя.

Пример формата — Europe/Moscow.
deviceAppInfo.
notificationAlertAllowed
booleanНеобязательныйРазрешение на отображение уведомлений для приложения.

Возможные значения:
• true — отображение разрешено;
• false — отображение запрещено.
deviceAppInfo.
notificationDelayedViewEnabled
booleanНеобязательныйНаличие приложения в сводке уведомлений. Только для iOS.

Возможные значения:
• true — приложение есть в сводке;
• false — приложения нет в сводке.
deviceAppInfo.
timeSensitiveNotificationAllowed
booleanНеобязательныйРазрешение на отображение чувствительных ко времени уведомлений. Только для iOS.

Возможные значения:
• true — отображение разрешено;
• false — отображение запрещено.
* Деятельность компании Meta запрещена на территории Российской Федерации.