Skip to content

Получение данных посетителя

Получение данных посетителя

Метод getobj.visitor
Описание Получение данных посетителя
Кому доступен Агент, Клиент
Необходимые компоненты для работы с методом Data API для настройки
Вес метода 0 баллов

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
id number да Уникальный идентификатор посетителя на сайте

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

Название Тип Допустимые значения Ответ по умолчанию Описание
name string Имя посетителя
phone_numbers array Список номеров контакта
emails array Список электронных адресов
Свойства посетителя
properties array Свойства посетителя
id number ИД свойства
name string Название свойства
value string Значение

JSON структура запроса

{
    "jsonrpc":"2.0",
    "id":"number",
    "method":"getobj.visitor",
    "params":{
        "access_token":"string",
        "user_id":"number",
        "id": "number"
    }
}

JSON структура ответа

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {

        },
        "data":  {
            "name":"number",
            "phone_numbers": [
                "string"
            ],
            "emails":[
                "string"
            ],
            "properties":[
                {
                    "id":"number",
                    "name":"string",
                    "value": "string"
                }
            ]
        }
    }
}

JSON пример ответа

{
    "jsonrpc": "2.0",
    "id": "rMiS6Y5qt1OYo2m9S3S3z",
    "result": {
        "data":  {
            "name":"Имя",
            "phone_numbers": [
                "7900000000",
                "7900000001"
            ],
            "emails":[
                "email1@mail.ru"
            ],
            "properties":[
                {
                    "id":1,
                    "name":"Логин",
                    "value": "login"
                }
            ]
        }
    }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом getobj"