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

Обновлено: 30 сентября 2024

Для привязки пуш-устройства к получателю используется метод 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
    }
}

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

Параметр	Тип данных	Характер	Описание
subscriber	object	Необязательный	Получатель сообщения. Может включать идентификатор получателя в edna Pulse, номер телефона получателя или другие необходимые идентификаторы.
subscriber.address	string	Обязательный	Значение типа идентификатора, указанного в параметре type. Например, если в параметре type указано PHONE, то в параметре address будет номер телефона клиента.
subscriber.type	string	Обязательный	Тип идентификатора получателя.
deviceAppInfo	object	Необязательный	Данные устройства пользователя.
deviceAppInfo.deviceAddress	string	Обязательный	Уникальный пуш-адрес устройства пользователя edna Pulse, меняется вместе с изменением токенов в пуш-облаках. Также используется как DEVICE_APP_ID. Приходит в колбэке от мобильных пуш-библиотек edna Pulse: - iOS — EDNAPushXDeviceInfo - Android — onDeviceAddressChanged
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 запрещена на территории Российской Федерации.