Skip to content

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

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

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

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

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

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

Название Тип Допустимые значения Ответ по умолчанию Описание
id number да Уникальный идентификатор посетителя
name string да ФИО посетителя
phones array да Список номеров посетителя
emails array да Адреса электронной почты посетителя
usernames array да Юзернеймы посетителя

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

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

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

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

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

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

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

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

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