Getting visitor data

Getting visitor data

Method	get.visitors
Description	Getting visitor data
Available to	Agent, Client
Required components	Data API for configuration
Method weight	1 point

Request parameters

Name	Type	Required	Description
access_token	string	yes	Authentication session key
user_id	number	no	Unique identifier of the customer's user on whose behalf the request is made. Required for the agent.
ids	array	yes	List of unique visitor IDs

Response parameters

Name	Type	Required	Description
id	number	yes	Unique visitor identifier
name	string	yes	Visitor's name
phones	array	yes	Visitor's phone numbers
emails	array	yes	Visitor's email addresses
usernames	array	yes	Visitor usernames

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.visitors",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "ids": "array"
    }
}

Response structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "id": "number",
                "name": "string",
                "emails": [ "email" ],
                "phones": [ "phone" ],
                "usernames": [ "username" ]
            }
        ]
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": [
            {
                "id": 10117621191,
                "name": "test1",
                "emails": [ "test1@test1.ae", "test@test.ae" ],
                "phones": [],
                "usernames": [ "test1", "test2" ]
            },
            {
                "id": 10117119711,
                "name": "test2",
                "emails": [],
                "phones": [ "71111111111", "71111111112" ],
                "usernames": [ "test3" ]
            }
        ]
    }
}

List of returned errors

See "Errors for get methods".