Получение всех visitor с контактными данными по person_id
Получение person_id по visitor_id
Метод | get.person_visitors |
---|---|
Описание | Получение всех visitor с контактными данными по person_id |
Кому доступен | Агент, Клиент |
Необходимые компоненты для работы с методом | Data API для настройки |
Вес метода | 0 баллов |
Параметры запроса
Название | Тип | Обязательный | Описание |
---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
person_id |
number | да | Уникальный идентификатор персоны |
Параметры ответа
Название | Тип | Допустимые значения | Ответ по умолчанию | Описание |
---|---|---|---|---|
person_id |
number | да | Уникальный идентификатор Персоны | |
visitor_id |
number | да | Уникальный идентификатор посетителя на сайте | |
name |
string | нет | ФИО посетителя | |
phones |
array | нет | Список номеров посетителя. | |
emails |
array | нет | Адреса электронной почты посетителя. | |
company |
string | нет | Компания посетителя | |
commentary |
string | нет | Комментарий |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.person_visitors",
"params":{
"access_token":"string",
"user_id":"number",
"person_id": "number"
}
}
JSON структура ответа
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"person_id": "number",
"visitor_id": "number",
"name": "string",
"emails":[
"email"
],
"phones":[
"phone"
],
"company": "string",
"commentary": "string",
}
]
}
}
JSON пример ответа
{
"jsonrpc": "2.0",
"id": "rMiS6Y5qt1OYo2m9S3S3z",
"result": {
"data": [
{
"name": "Тест",
"emails": [
"test@1.ry",
"test@2.ru"
],
"phones": [
"213123123213",
"43534534543"
],
"company": "ООО Ромашка",
"person_id": 6145241079,
"commentary": "Какойто комментарий",
"visitor_id": 6152759362
},
{
"name": "346356",
"emails": [
"qere4@fsdfsd.ry"
],
"phones": [
"213123123213",
"74564565465"
],
"company": null,
"person_id": 6145241079,
"commentary": null,
"visitor_id": 6152759377
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"