Contacts

Contact endpoints are meant to manage the contacts of the audience. A contact is a phone number in the audience having personal details that are valid only in the scope of the audience.

Method: Query

Operation to query all contacts of the audience.

URL /v1/audiences/{audience_id}/contacts
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 encoded pagination details Optional
page_size string number of records to be retrieved Optional
filter[search] string Filter contacts by searched value Optional

Request Body

-empty-

Response Parameters

Name Type Description
data array

Details

(see data object below)
pagination object

Details

(see pagination object below)
data object
Name Type Description
id string Unique identifier of the contact
account_id string Unique identifier of the account
audience_id string Unique identifier of the audience
number string Phone number of the contact
first_name string First name of the contact
last_name string Last name of the contact
timestamp string Timestamp value
date string Date value to customize massages per contact
create_date string Creation date of the contact in UTC, formatted as yyyyMM-dd HH:mm:ss
update_date string Update date of the contact in UTC, formatted as yyyy-MMdd HH:mm:ss
pagination object
Name Type Description
number integer Number of current page
size integer Items count in page
total integer Total count of items
links object

Details

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

Example of request body

GET: /v1/audiences/22089fd7-7b74-4815-8452-3a8e864affbc/contacts
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
                        

                    

                    
                                                    

                                1351
                                Contact is not found
                            

                                                        

                                1352
                                Invalid contact identifier
                            

                                                        

                                1353
                                'data.number' is required
                            

                                                        

                                1354
                                'data.number' is invalid
                            

                                                        

                                1355
                                'data.number' is too long
                            

                                                        

                                1359
                                'data.tags' must be at most [10] items in length
                            

                                                        

                                1360
                                Contact already exists
                            

                                                        

                                1361
                                First name is too long
                            

                                                        

                                1362
                                Last name is too long
                            

                                                        

                                1363
                                Timestamp value is too long
                            

                                                        

                                1364
                                Date value is too long