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

Для запроса на получение данных получателя используется метод api/subscribers/get-by-address.

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

Вызов метода api/subscribers/get-by-address

Чтоб вызвать метод api/subscribers/get-by-address, отправьте GET-запрос на URL-адрес https://app.edna.io/api/subscribers/get-by-address.

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

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

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

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

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

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

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

ПараметрТип данных Описание
idnumberВнутренний идентификатор получателя в edna Pulse.
blacklistedbooleanОпределяет, будет ли получатель исключен из рассылок.

Возможные значения:
true — получатель находится в черном списке и не может принимать рассылки;
false — получатель может принимать рассылки.
addressesarrayМассив адресов и идентификаторов получателя.
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.

Для этих типов доступны разные параметры. Подробнее в примере ответа.
parameterValuesarrayМассив переменных.
namestringНазвание переменной.
valueTypestringТип переменной.

Возможные значения:
STRING
ENUM
DATE
NUMBER
BOOLEAN
valuestringЗначение параметра.
tagValuesarrayМассив тегов.
namestringИмя тега.
* Деятельность компании Meta запрещена на территории Российской Федерации.