Запрос данных получателя

Метод get-by-address возвращает данные получателя по его идентификатору EXT_USER_ID.

Признак EXT_USER_ID присваивается получателю при его создании. Необходимо знать значение EXT_USER_ID, чтобы запросить данные получателя.

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

Для использования метода отправьте GET-запрос https://app.edna.ru/api/subscribers/get-by-address.

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

ПараметрТипОбяза
тельный
Описание
addressstringдаЗначение EXT_USER_ID, которое было присвоено получателю при его создании.
typestringдаEXT_USER_ID

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

{
  "address": "id87552",
  "type": "EXT_USER_ID"
}

Параметры ответа

ПараметрТип Описание
idnumberВнутренний идентификатор получателя в edna Pulse
blacklistedbooleanОпределяет, будет ли получатель исключён из рассылок: true — клиент в “чёрном списке” и не получает рассылки, false — клиент получает рассылки
addressesobjectМассив адресов и идентификаторов получателя
addresses.idstringИдентификатор адреса
addresses.addressstringАдрес получателя, например, номер телефона или учетная запись
addresses.typestringТип адреса получателя (EDNA_ID, PHONE, EMAIL, UTM, COOKIE_ID, INSTAGRAM_ID, FACEBOOK_ID, TELEGRAM_ID, GOOGLE_ID, APPLE_ID, YANDEX_ID, DEVICE_APP_ID, EXT_USER_ID)
addresses.infoobjectСлужебная информация об адресе
addresses.info.@type stringТип идентификатора получателя:
– PhoneInfo — номер телефона
– DeviceAppInfo — идентификатор пуш-устройства DEVICE_APP_ID

Для этих типов доступны разные параметры, см. пример ответа ниже.
parameterValuesobjectМассив переменных
namestringНазвание переменной
valueTypestringТип переменной (STRING, ENUM, DATE, NUMBER, BOOLEAN)
valuestringЗначение параметра
tagValuesobjectМассив тегов
namestringИмя тега

Пример ответа

{
    "id": 63979781,
    "blacklisted": false,
    "addresses": [
        {
            "id": "2f1c95bd-897d-4dec-a45b-f13b0f16c558",
            "address": "79006006969",
            "type": "PHONE"
            "info": {
                "@type": "PhoneInfo",
                "phoneStatus": "VALID",
                "phonePrefix": "7900600",
                "operatorUnitRegion": {
                    "id": 135,
                    "operatorUnitId": 40,
                    "name": "Липецкая область",
                    "code": "russia-tele2-tele2_lipetsk-lipeckaya_oblast",
                    "timeZone": "Europe/Moscow"
                }
            }
        },
        {
            "id": "9b2aff72-f34f-4319-ae4b-bcd854b8ac22",
            "address": "id87552"
            "type": "EXT_USER_ID"
        },
        {
            "id": "d70a07cf-6e29-492a-bedf-da2fe3800b71",
            "address": "gcmv9v9ewctw12ekdy6nbit2g82gfhit1w",
            "type": "DEVICE_APP_ID"
            "info": {
                "@type": "DeviceAppInfo",
                "deviceName": "android-build",
                "systemName": "Google Pixel 4a",
                "deviceUID": "6e083b67005411b28e736bbcda15d0a2b5d8bb08",
                "appPackageName": "com.edna.android.push.demo_x",
                "pushAppType": "ANDROID"
            }
        }
    ],
    "parameterValues": [],
    "tagValues": [
        {
            "name": "new_users"
        }
    ]
}