Audiences

An audience is a group of contacts that can be targeted in the same campaign. The audiences and the contacts of the audiences are managed by the user through Audience API.

Audience endpoints are meant to control the audiences of the accounts.

Method: Query

Operation to query all audiences of the account.

URL /v1/audiences
Method Type GET
Authorization API Key
Request Content-Type JSON
Response Content-Type JSON

Headers

Name Type Description Status
X-Dexatel-Key string API key Required

Query parameters

Name Type Description Status
page_token string Token with the encoded pagination details Optional
page_size string Number of records to be retrieved Optional
filter[channel] string Filter audiences by channel (SMS, Viber, Whatsapp) Optional

Request Body

-empty-

Response Parameters

Name Type Description Status
data array

Details

(see data object below)
Optional
pagination object

Details

(see pagination object below)
Optional
data object
Name Type Description Status
id string Unique identifier of the audience Optional
account_id string Unique identifier of the account Optional
name string Name (unique identifier) of the audience Optional
channel string Channel to which contacts belong. Possible values: SMS, VIBER WHATSAPP Optional
create_date string Creation date of the audience in UTC, formatted as yyyyMM-dd HH:mm:ss Optional
update_date string Update date of the audience in UTC, formatted as yyyyMM-dd HH:mm:ss Optional
pagination object
Name Type Description Status
number integer Number of current page Optional
size integer Items count in page Optional
total integer Total count of items Optional
links object

Details

(see links object below)
Optional
links object
Name Type Description Status
first string Optional
current string Optional
previous string Optional
next string Optional

Example of request body

GET: /v1/audiences
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace

Example of response body

status - 200

                
                        

Error Codes

The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.

Code Description
1301 Audience is not found
1302 Invalid audience identifier
1303 'data.audience' name is required
1304 'data.name' is invalid
1305 'data.name' is too long
1306 'data.channel' is missing
1307 'data.channel' should be in: [SMS, WHATSAPP, VIBER]
1308 'data.contacts' must be at most [10] items in length
1309 Audience already exists