Requesting Client Data

Last updated: 1 October 2024

The api/subscribers/get-by-address method is used to request the recipient's data.

info

To request the recipient's data, its unique identifier is required, specified in the EXT_USER_ID parameter at creation.

Creating Clients

Calling the api/subscribers/get-by-address method

To call the api/subscribers/get-by-address method, send a GET request to the URL https://app.edna.io/api/subscribers/get-by-address

Request Body Format

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

Request Parameters

Parameter	Data type	Character	Description
address	string	Required	The unique identifier of the recipient specified as the value of the EXT_USER_ID parameter when creating the recipient.
type	string	Required	The ID type. The value is EXT_USER_ID.

Response Example

{
    "id": 63979781,
    "blacklisted": false,
    "addresses": [
        {
            "id": "2f1c95bd-897d-4dec-a45b-f13b0f16c558",
            "address": "357000000000",
            "type": "PHONE"
        },
        {
            "info": {
                "@type": "PhoneInfo",
                "phoneStatus": "VALID",
                "phonePrefix": "357000000000",
                "operatorUnitRegion": {
                    "id": 135,
                    "operatorUnitId": 40,
                    "name": "New York",
                    "code": "usa-sprint_new_york",
                    "timeZone": "NA/Eastern_Time_Zone"
                }
            }
        },
        {
            "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"
        }
    ]
}

Responce parameters

Parameter	Data type	Description
id	number	The recipient's internal identifier in edna Pulse.
blacklisted	boolean	Determines whether the recipient will be excluded from the broadcast lists. - true — the recipient is blacklisted and cannot receive broadcasts; - false — the recipient can receive broadcasts.
addresses	array	An array of recipient addresses and IDs.
addresses.id	string	The address ID.
addresses.address	string	The recipient's address. For example, a phone number or an account.
addresses.type	string	The recipient's address type.
addresses.info	object	Official information about the address.
addresses.info.@type	string	The type of the recipient's ID. - PhoneInfo — phone number; - DeviceAppInfo — push device ID DEVICE_APP_ID.
parameterValues	array	An array of variables.
name	string	The name of the variable.
valueType	string	The type of the variable. Possible values: - STRING - ENUM - DATE - NUMBER - BOOLEAN
value	string	The parameter value.
tagValues	array	An array of tags.
name	string	The tag name.