Продукты Решения Тарифы Партнерам
Клиентам
Получить консультацию
Связаться
Skip to content

Получение списка всех обращений

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
report_id number да Уникальный идентификатор отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list"
date_from iso8601 да YYYY-MM-DD hh:mm:ss Дата начала основной выборки(ограничение 366 дней)
date_till iso8601 да YYYY-MM-DD hh:mm:ss Дата окончания основной выборки
fields array нет Список идентификаторов пользовательских столбцов, разделенных запятой. Доступный список столбцов см.раздел "Получение вложенности столбцов" . Порядок влияет на ответ.
Фильтры применяемые в отчете
filter object нет Допустимо использовать не более 2 уровней вложенности. Смотри примеры ниже Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации"
filters array да Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Получение списка возможных условий фильтрации для отчета" .
field string Поле сущности к которой будет применяться фильтрация (список заранее определен для метода)
operator enum Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации"
value string Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота.
Сортировка применяемая в отчете
sort array нет Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных"

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

Копировать

Внимание! Могут быть доступны не все параметры ответа, для получения полного и актуального для вас списка, воспользуйтесь списком мнемоник(id) столбцов из ответа  "Получение вложенности столбцов" 
Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
site_domain_name string да да да Адрес сайта в интернете. Без указания протокола - "http://" или "https://"
site_domain_naked string да да да Основной домен адреса сайта в интернете.
site_name string да да да Название сайта.
Обращения
communication_type object да да да Тип обращения
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
communication_id string да да да Уникальный идентификатор обращения.
communication_date_time iso8601 YYYY-MM-DD hh:mm:ss да да да Дата и время обращения
communication_kinds array да Вид обращения
communication_page_url string да да URL страницы на которой находился посетитель в момент обращения или страница последнего взаимодействия посетителя перед обращением.
is_communication_with_visit object да да Есть связь обращения с сессией
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
communication_number number да да да Номер обращения. Рассчитывается в рамках персоны.
contact_phone_number string да да да Номер контакта от которого поступил звонок в случае входящего звонка или номер контакта на который совершили звонок в случае исходящего звонка.
virtual_phone_number string да да да Виртуальный номер
contact_full_name string да да да Фамилия Имя Отчество контакта или имя указанное в заявке.
total_duration number да да Длительность звонка или продолжительность чата, значение в секундах
Проставленные теги
tags object да да Теги
    communication_id
number Уникальный идентификатор обращения.
    communication_type
string Тип обращения
    items
array Список тегов с параметрами
      id
number Уникальный идентификатор тега
      name
string Название тега
Сотрудники участвовавшие в звонке, чате или заявке
employees array да Сотрудники, которые участвовали в звонке
employee_full_name string Ф.И.О. сотрудника
Источники трафика
campaign_name string да да да Название рекламной кампании
channel_new string да да да Канал(new). Название канала источника
channel_code string да да да Мнемоника канала
source_new string да да да Источник(new). Группа источника
source_name string да да да Источник(детальный). Название источника
channel string да да Канал.
source string да да Источник.
referrer string да да Источник перехода
referrer_domain string да да Домен реферера
search_query string да да Поисковый запрос
Параметры рекламной кампании
eq_utm_source string да да Расширенная UTM-метка Source
eq_utm_medium string да да Расширенная UTM-метка Medium
eq_utm_term string да да Расширенная UTM-метка Term
eq_utm_content string да да Расширенная UTM-метка Content
eq_utm_campaign string да да Расширенная UTM-метка Campaign
eq_utm_referrer string да да Расширенная UTM-метка Referrer
eq_utm_expid string да да Расширенная UTM-метка Expid
Метки UTM
utm_source string да да UTM-метка Source
utm_medium string да да UTM-метка Medium
utm_term string да да UTM-метка Term
utm_content string да да UTM-метка Content
utm_campaign string да да UTM-метка Campaign
utm_referrer string да да UTM-метка Referrer
utm_expid string да да UTM-метка Expid
Метки Openstat
openstat_ad string да да Идентификатор рекламного объявления
openstat_campaign string да да Идентификатор рекламной кампании
openstat_service string да да Идентификатор сервиса, предоставляющего услуги
openstat_source string да да Идентификатор площадки, раздела, страницы, было показано соответствующее рекламное объявление
Другие URL-метки
ef_id string да да Используется для разметки ссылок в системе управления контекстной рекламой AdLense
yclid string да да Yandex Click Identifier
gclid string да да Метка gclid
cm_id string да да cm_id - это набор ValueTrack. ValueTrack - это параметры URL, которые можно добавлять к URL целевых страниц, чтобы собирать информацию об источнике кликов.
ymclid string да да Значение метки ymclid
tag_from string да да Метка from
География
visitor_country string да да Страна посетителя
visitor_region string да да Регион посетителя
visitor_city string да да Город посетителя
visitor_provider string да да Интернет провайдер посетителя
visitor_ip_address string да да IP-адрес посетителя
Компьютер
visitor_browser_name string да да Браузер посетителя
visitor_browser_version string да да Версия браузера посетителя
visitor_os_name string да да Название операционной системы посетителя
visitor_os_version string да да Версия операционной системы посетителя
visitor_language string да да Локализация устройства посетителя
visitor_screen string да да Разрешение монитора посетителя
visitor_device object да да Устройство посетителя
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
История посетителя
visitor_session_id number да да Уникальный идентификатор сессии посетителя
entrance_page string да да Страница входа
visitor_type object да да Тип посетителя
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
visitor_id number да да да Уникальный идентификатор посетителя
person_id number да да да Уникальный идентификатор персоны
ua_client_id string да да Уникальный идентификатор в Universal Analytics
ym_client_id string да да Уникальный идентификатор пользователя Яндекс.Метрики
Список сегментов
segments array да Сегменты
segment_name string да Название сегмента
Время посещения
visit_date iso8601 YYYY-MM-DD да да Дата посещения
visit_hour object да да Час посещения
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
visit_weekday object да да День недели посещения
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
visit_month object да да Месяц посещения
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
visit_year string да да Год посещения
Звонки
call_type object да да да Тип звонка
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
call_status object да да да Признак, что звонок потерянный или успешный
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
call_direction object да да да Направление звонка
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
phone_tracking_type object да да Тип номера коллтрекинга
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
call_region_name string да да Регион номера абонента
call_records array да да Уникальный идентификатор ссылки на записанный разговор.
Заявки
offline_message_type object да да да Тип заявки
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
offline_message_email string да да да Адрес электронной почты оставленный посетителем в заявке
offline_message_text string да да да Текст оставленный посетителем в заявке
Чаты
chat_initiator object да да да Инициатор чата
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
chat_status object да да да Статус чата
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
chat_messages_count number да да да Количество сообщений в чате
Цели
goal_type object да да Тип цели
    value
string Имя значений
    value_id
string Уникальный идентификатор значения
goal_name string да да да Название цели
deals array нет нет нет Связанные сделки
    ext_id
string Внешний уникальный идентификатор сделки
    date_time
iso8601 Время сделки
    current_stage
string Текущий этап сделки
Почта
email_message string да да да Тело письма
email_from string да да да Отправитель
email_cc array да да да Копия. Массив адресов.
email_bcc array да да да Скрытая копия. Массив адресов.
email_message_html string да да да Тело письма HTML
email_to string да да да Получатель
email_subject string да да да Тема письма

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

Копировать
{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.communications",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "offset":"number",
  "limit":"number",
  "report_id": "number",
  "date_from":"iso8601",
  "date_till":"iso8601",
  "filter":{

  },
  "sort":[
   {
    "field":"string",
    "order":"string"
   }
  ],
  "fields":[
   "string"
  ]
 }
}

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

Копировать
{
 "jsonrpc":"2.0",
 "id":"number",
 "result":{
  "metadata":{

  },
  "data":[
  {
  "site_domain_name":"string",
    "site_domain_naked":"string",
    "communication_type":{
      "value_id": "string",
      "value": "string"
    },
    "communication_id":"string",
    "communication_date_time":"iso8601",
    "communication_kinds":[

    ],
    "communication_page_url":"string",
    "is_communication_with_visit":{
      "value_id": "string",
      "value": "string"
    },
    "communication_number":"number",
    "contact_phone_number":"string",
    "virtual_phone_number":"string",
    "contact_full_name":"string",
    "total_duration":"number",
    "tags":{
      "communication_id": "number",
      "communication_type": "string",
      "items":[
        {
         "id": "string",
         "name": "string"
        }
      ]
    },
    "employees":[
     {
      "employee_full_name":"string"
     }
    ],
    "campaign_name":"string",
    "channel_new":"string",
    "channel_code":"string",
    "source_new":"string",
    "source_name":"string",
    "channel":"string",
    "source":"string",
    "referrer":"string",
    "referrer_domain":"string",
    "search_query":"string",
    "eq_utm_source":"string",
    "eq_utm_medium":"string",
    "eq_utm_term":"string",
    "eq_utm_content":"string",
    "eq_utm_campaign":"string",
    "eq_utm_referrer":"string",
    "eq_utm_expid":"string",
    "utm_source":"string",
    "utm_medium":"string",
    "utm_term":"string",
    "utm_content":"string",
    "utm_campaign":"string",
    "utm_referrer":"string",
    "utm_expid":"string",
    "openstat_ad":"string",
    "openstat_campaign":"string",
    "openstat_service":"string",
    "openstat_source":"string",
    "ef_id":"string",
    "yclid":"string",
    "gclid":"string",
    "cm_id":"string",
    "ymclid":"string",
    "tag_from":"string",
    "visitor_country":"string",
    "visitor_region":"string",
    "visitor_city":"string",
    "visitor_provider":"string",
    "visitor_ip_address":"string",
    "visitor_browser_name":"string",
    "visitor_browser_version":"string",
    "visitor_os_name":"string",
    "visitor_os_version":"string",
    "visitor_language":"string",
    "visitor_screen":"string",
    "visitor_device":{
      "value_id": "string",
      "value": "string"
    },
    "visitor_session_id":"number",
    "entrance_page":"string",
    "visitor_type":{
      "value_id": "string",
      "value": "string"
    },
    "visitor_id":"number",
    "person_id":"number",
    "ua_client_id":"string",
    "ym_client_id":"string",
    "segments":[
     {
      "segment_name":"string"
     }
    ],
    "visit_date":"iso8601",
    "visit_hour":{
      "value_id": "string",
      "value": "string"
    },
    "visit_weekday":{
      "value_id": "string",
      "value": "string"
    },
    "visit_month":{
      "value_id": "string",
      "value": "string"
    },
    "visit_year":"string",
    "call_type":{
      "value_id": "string",
      "value": "string"
    },
    "call_status":{
      "value_id": "string",
      "value": "string"
    },
    "call_direction":{
      "value_id": "string",
      "value": "string"
    },
    "phone_tracking_type":{
      "value_id": "string",
      "value": "string"
    },
    "call_region_name":"string",
    "call_records":[

    ],
    "offline_message_type":{
      "value_id": "string",
      "value": "string"
    },
    "offline_message_email":"string",
    "offline_message_text":"string",
    "chat_initiator":{
      "value_id": "string",
      "value": "string"
    },
    "chat_status":{
      "value_id": "string",
      "value": "string"
    },
    "chat_messages_count":"number",
    "goal_type":{
      "value_id": "string",
      "value": "string"
    },
    "goal_name":"string",
    "deals": [
        {
          "ext_id": "string",
          "date_time": "iso8601",
          "current_stage": "string"
        },
        {
          "ext_id": "string",
          "date_time": "iso8601",
          "current_stage": "string"
        }
    ]
  }
  ]
 }
}

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

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

Полезные кейсы, статьи и исследования от экспертов UIS
Подписаться
Нажимая кнопку вы подтверждаете, что согласны получать рассылку
Вы успешно подписаны на новости!
Спасибо за обращение
Понятно