Метод logout

12 декабря 2023

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

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

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

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

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

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

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

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

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

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

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

Возможные значения (необходимо указывать в верхнем регистре):
• 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": "6e083b67005411b28e736bbcda15d0a2b5d8bb08",
    "appPackage": "com.edna.android.push.demo_x_bestapp5000_c6b91927-0d8e-4f43-a507-c3f216c56319",
    "locale": "RU",
    "timezone": "Europe/Moscow",
    "notificationAlertAllowed": true,
    "notificationDelayedViewEnabled": false,
    "timeSensitiveNotificationAllowed": false
  }
}
In this article
Разделы статьи