Выгрузка журнала звонков

При использовании данного параметра, включается постраничный формат выборки. В данном параметре указывается номер страницы. При этом на одной странице может быть отображено до 1000 звонков. Формат: page=X, где X >= 1

Уникальный идентификатор Яндекс.Метрика. Значение параметра не равно null, если настроена выгрузка звонков в Яндекс.Метрика.

Обратите внимание! Даже если выгрузка звонков в Яндекс.Метрика настроена, в некоторых случаях Яндекс.Метрика не присваивает свой ИД пользователю:

• Счетчик Яндекс.Метрика не установлен на сайт.
• Счетчик установлен неправильно.
• Работу счетчика Яндекс.Метрика на сайте блокируют другие скрипты. Проверить это можно в консоли браузера.
• Счетчик заблокирован расширением Adblock Plus.
• Домен mc.yandex.ru заблокирован в файле hosts вашей ОС.

Значение yaClientId в этих случаях будет равно null.

Модель атрибуции звонков. Возможные значения:

• 0 — последнее взаимодействие
• 1 — последний непрямой (по умолчанию, если параметр не указан)

Более подробно о моделях атрибуции Вы можете узнать в соответствующей статье.

Флаг выгрузки звонков с привязкой к разным метрикам. Возможные значения:

• call — по дате звонков (по умолчанию)
• session — по дате сессий 

В качестве его значения можно указать ФИО менеджера, для выгрузки только тех звонков, которым был присвоен этот менеджер ( например с помощью API-метода присвоения менеджеров к лидам).

Флаг выгрузки уникальных звонков. Формат:

• uniqueOnly=true — выгружаются только уникальные
• uniqueOnly=false — выгружаются только повторные

Если не указывать флаг, то выгружаются все звонки.

Флаг выгрузки целевых звонков. Формат:

• targetOnly=true — выгружаются только целевые
• targetOnly=false — выгружаются только нецелевые

Если не указывать флаг, то выгружаются все звонки.

Флаг выгрузки уникально-целевых звонков. Формат:

• uniqTargetOnly=true — выгружаются только уникально-целевые
• uniqTargetOnly=false — выгружаются только не уникально-целевые

Если не указывать флаг, то выгружаются все звонки.

Флаг выгрузки обратных звонков. Формат:

• callbackOnly=true — выгружаются только обратные звонки из виджета обратного звонка или из кастомных форм, подключенных к обратному звонку Calltouch.
• callbackOnly=false — выгружаются только прямые звонки на отслеживаемые номера

Если не указывать флаг, то выгружаются все звонки.

Флаг отображения тегов звонков. Формат: withCallTags=true - отображать теги, withCallTags=false или отсутствие параметра — не отображать теги.

Обратите внимание! Теги передаются по API на момент запроса. Если Вы используете автотегирование Predict или Antifrod, то теги к звонкам присваиваются не сразу, поэтому API запрос на получение тегов Predict или Antifrod рекомендуется производить спустя 1 неделю после звонка.

Флаг отображения комментариев к звонкам, оставленных в плеере журнала звонков. Формат:

• withComments=true — отображать комментарии
• withComments=false или отсутствие параметра — не отображать комментарии

Комментарии отображаются в выходном параметре comments.

Флаг выгрузки данных по рекламным кампаниям Яндекс.Директ. Если входной параметр withYandexDirect = true, то в выгрузке присутствует выходной параметр yandexDirect, если withYandexDirect = false или не указан, то выходной параметр yandexDirect отсутствует.

Флаг выгрузки разговора звонка в текстовой форме. Формат:

• withText=true — отображать текст разговора
• withText=false или отсутствие параметра — не отображать текст разговора

Текст разговора отображается в выходном параметре phrases.

Флаг выгрузки данных ФИО, E-mail, номер телефона, пользовательские поля, полученных из виджетов.
Для виджетов лид-форм Facebook, VK также выгружаются id лида и id объявления.

Формат:

• withCallbackInfo=true — выгружать данные;
  
• withCallbackInfo=false или отсутствие параметра — не выгружать данные.
  

Данные будут доступны только для обратных звонков в выходном параметре сallbackInfo.

Если виджет на заявках или заявки в нерабочее время не прозваниваются, то данные из виджетов доступны в параметре withWidgetInfo выгрузки заявок из ЛК.

Флаг выгрузки данных по пользовательским полям.

Формат:

• withCustomFields=true — выгружать данные по пользовательским полям
• withCustomFields=false — не выгружать данные

Если параметр не указан - по умолчанию false

Данные будут доступны в выходном параметре customFields.

Флаг выгрузки данных по интеграции с DoubleClick Campaign Manager. Возможные значения:

• true — выгрузить данные по отправке звонка в DCM
• false — не выгружать данные

По каждому звонку может быть несколько отправок в DCM, в соответствии с настройками интеграции. Поэтому в ответе будет массив данных, каждая отправка будет в отдельном элементе массива. В ответ на запрос к API попадает последняя попытка отправки на момент обращения к нашему API.

Формат ответа:

1. Если withDcm не задано или false, то:
"dcm": null
2. Если withDcm=true, но не было отправок в DCM, то:
"dcm": []
3. Если withDcm=true, отправки были, то:
"dcm": [
{
"profileIdDCM": 1411789,
"floodlightConfigurationId": "10355394",
"floodlightActivityId": "10501143",
"requestStatus": "ERROR",
"requestErrors": "HTTP_AUTH_ERROR"
}
]

Где:

• profileIdDCM — идентификатор профиля DCM
• floodlightConfigurationId — конфигурация из DCM
• floodlightActivityId — идентификатор флудлайта
• requestStatus — статус отправки звонка в DCM. Возможные значения:
  • success — успешная отправка
  • error — отправка, завершенная ошибкой
• requestErrors — описание ошибки отправки звонка в DCM, если она возникает. Если нет, то значение будет null.

Используется в постраничном формате выборки данных.

Содержит номер страницы.

Используется в постраничном формате выборки данных.

Содержит общее количество страниц.

Используется в постраничном формате выборки данных.

Содержит значения размера страницы. Если не установлен

входной параметр limit, значение по умолчанию равно 1000.

Используется в постраничном формате выборки данных.

Содержит общее количество звонков на всех страницах.

Используется в постраничном формате выборки данных.

Содержит запрашиваемые звонки и их выходные параметры,

перечисленные ниже в текущей таблице.

Фаза звонка на момент API запроса:

• callconnected - звонок сейчас идет в реальном времени
• calldisconnected - звонок завершен

• 0 — последнее взаимодействие
• 1 — последний непрямой (по умолчанию)

Номер переадресации. В случае, если номер переадресации

не один (настроена группа обзвона на несколько номеров

или номер переадресации зарубежный), то подставится значение "undefined".

ФИО менеджера, который был присвоен этому звонку с

помощью API-метода присвоения менеджеров к лидам.

• true (звонок удачный)
• false (звонок неудачный)

• true (уникальный звонок)
• false (повторный звонок)

• true (целевой звонок)
• false (нецелевой звонок)

• true (уникально-целевой звонок)
• false (не уникально-целевой звонок)

• true (обратный звонок из виджета обратного звонка
• или из кастомных форм, подключенных к обратному звонку)
• false (прямой звонок на отслеживаемый номер)

Отслеживаемый домен или поддомен ресурса, на который

был осуществлен переход (например: yoursite.ru).

Уникальный идентификатор клиента в Calltouch.
Определяется по номеру телефона клиента. Его удобно использовать,

когда нужно идентифицировать клиента без использования его персональных данных (номер телефона).

Уникальный идентификатор Google Analytics 4. Параметр присутствует

в случае, если настроена интеграция Calltouch с Google Analytics 4.

Уникальный идентификатор Яндекс.Метрика. Значение параметра не равно null, если настроена выгрузка звонков в Яндекс.Метрика.

Обратите внимание! Даже если выгрузка звонков в Яндекс.Метрика настроена, в некоторых случаях Яндекс.Метрика не присваивает свой ИД пользователю:

• Счетчик Яндекс.Метрика не установлен на сайт.
• Счетчик установлен неправильно.
• Работу счетчика Яндекс.Метрика на сайте блокируют другие скрипты. Проверить это можно в консоли браузера.
• Счетчик заблокирован расширением Adblock Plus.
• Домен mc.yandex.ru заблокирован в файле hosts вашей ОС.

Значение yaClientId в этих случаях будет равно null.

История посещений. Параметр присутствует в случае, если указан входной параметр истории посещений withMapVisits=true. Результат будет содержать все посещения посетителя до и после совершения звонка со следующими данными:

• sessionDate (дата начала сессии посетителя на сайте)
• sessionID
• ip
• userAgent
• sessionId
• city
• source
• medium
• keyword
• url
• ref
• utmMedium
• utmSource
• utmTerm
• utmContent
• utmCampaign
• guaClientId (уникальный идентификатор Universal Analytics, он же clientId)
• ctClientId
• ctGlobalId

• createdDate (дата создания контракта)
• completedDate (дата подписания контракта)
• orderDate (дата заказа)
• orderNumber (номер заказа)
• plannedAmount (планируемая сумма контракта)
• completedAmount (реальная сумма контракта)
• orderId (ID сделки в Calltouch)

Создание и редактирование сделок по звонкам осуществляется при этом через отдельный интерфейс API, ознакомиться с инструкцией по которому можно в соответствующей статье.

• name (имя дополнительного параметра отслеживания платного трафика)
• value (значение дополнительного параметра отслеживания платного трафика)

Теги звонков, присутствуют в случае, если указан входной параметр withCallTags=true. Параметр содержит следующие данные:

• category (категория тега, по умолчанию равна имени тега)
• names (имя тега)

Обратите внимание! Теги передаются по API на момент запроса. Если Вы используете автотегирование Predict или Antifrod, то теги к звонкам присваиваются не сразу, поэтому API запрос на получение тегов Predict или Antifrod рекомендуется производить спустя 1 неделю после звонка.

category — устаревший параметр, оставлен в API для обратной совместимости и в ЛК нигде не используется.

Теги нужно парсить из callTags[i].names. Если там встречается запятая — это разделить тегов и их там несколько.

Комментарии к звонкам, оставленные в плеере журнала звонков. Выгружаются, если присутствует входной параметр withComments=true. Возможные значения:

• Если у звонка не будет комментариев, значение параметра будет в виде пустого массива:
  "comments": []
• Если у звонка будут комментарии, значение параметра будет массив комментариев:

• "comments": [
  {
  "commentId": 611916,
  "callId": 31435734,
  "comment": "Комментарий 1\n",
  "partyId": 882,
  "partyName": "login_1"
  },
  {
  "commentId": 611917,
  "callId": 31435734,
  "comment": "Комментарий 2\n",
  "partyId": 7309,
  "partyName": "login_2"
  },
  ...
  ]
     

  
  Где:

• commentId — ид комментария (число)
• callId — ид звонка, по которому оставлен комментарий (число)
• comment — комментарий (строка)
• partyId — ид пользователя, оставившего комментарий (число)
• partyName — логин пользователя, оставившего комментарий (строка)

Обратите внимание, в конце комментария может присутствовать символ \n. Он означает перенос строки, не забудьте учесть это при парсинге параметров.

Если источник звонка или заявки рекламная кампания Яндекс.Директ, между Calltouch и Яндекс.Директ включена интеграция, то в данном параметре выводится следующая информация:

• campaignId — ID кампании
• adGroupId — ID группы
• adId — ID объявления
• criteriaId — ID фразы
  Пример ответа, когда у звонка или заявки есть эти данные:

"yandexDirect":
        {
 "campaignId": 32515134,
         "adGroupId": 325245212134,
         "adId": 2546356252,
          "criteriaId": 254251323
        }
   

Пример ответа, когда у звонка или заявки нет этих данных (не настроена интеграция, либо данные еще не собрались):

"yandexDirect": null
   

• campaignId — ID кампании
• adGroupId — ID группы
• creativeId — ID объявления
• criteriaId — ID фразы
  Пример ответа, когда у звонка или заявки есть эти данные:

{
"campaignId": 35635656,
"adGroupId": 134524245,
"creativeId": 23134141,
"criteriaId": 4324553542
}
   

"googleAdWords":null   

Если у звонка имеется текстовая запись разговора, то в данном параметре выгружается массив фраз из звонка (соблюдая последовательность) в формате:

• channel — канал (1 - оператор, 0 - клиент)
• time — временная метка начала фразы в формате ММ:СС
• message — текст фразы

Пример, когда у звонка имеется текстовая запись разговора:

"phrases": [
   {
        "channel": 1,
        "time": "00:01",
        "message": "здравствуйте вы позвонили в компанию кола если вы всё ещё не используете наш сервис нажмите один если"
   },
   {
        "channel": 1,
        "time": "00:36",   
        "message": "добрый день какое кол ельвира слушаю вас"
    },
    {
        "channel": 0,
        "time": "00:36",
        "message": "добрый день дарья алексеевна я могу услышать"
     },
     {
        "channel": 1,
        "time": "00:42",
        "message": "а не по работе ден начинается десяти часов она еще не на месте"
      },
     {
         "channel": 0,
         "time": "00:48",
         "message": "хорошо благодарю спасибо"
      }, 
      {
         "channel": 1,
         "time": "00:50",
         "message": "всего доброго до свидания"
       }
       ]
   

Если текстовой записи разговора не имеется, то выводится пустой массив.

Пример, когда у звонка нет текстовой записи разговора:

"phrases": null   

Массив номеров телефонов, полученных из текста разговора (номера были произнесены в ходе разговора). Значение параметра в ответе формируется только при включении соответствующего сеттинга (требуется обратиться к вашему менеджеру). Если сеттинг не включен, или в звонке значение отсутствует (Сервис Calltouch Predict выключен или не успел обработать запись, или номеров в разговоре произнесено не было), то в значении будет null.

Данные (ФИО, email, номер телефона) из форм обратного звонка, оставленных в соц. сетях VK, Facebook и MyTarget. Выгружаются только для обратных звонков, если был передан входной параметр withCallbackInfo=true.

Формат:

[
    {
        ...
       "сallbackInfo" : {
         "fields": [
             {"name":"Имя", "value": "Дуся" },
             {"name": "Электронный адрес", "value": "mail@examle.ru" },
          ]
        }
      ...
   }
]   

Данные по пользовательским полям в звонках. Будут в ответе если был передан входной параметр withCustomFields=true.

Формат:

[
    {
        ...
       "customFields": [
            {"field": "name", "value": "Вася"},
            {"field": "birthday", "value": "1990-01-01"}
        ]
        ...
   }
]   

Данные по отправке звонка с DoubleClick Campaign Manager.

Формат ответа:

1. Если входной параметр withDcm (см. выше) не задан или false, то:

"dcm": null  

"dcm": []  

"dcm": [
{
"profileIdDCM": 1411789,
"floodlightConfigurationId": "10355394",
"floodlightActivityId": "10501143",
"requestStatus": "ERROR",
"requestErrors": "HTTP_AUTH_ERROR"
}
]  

Где:

• profileIdDCM — идентификатор профиля DCM
• floodlightConfigurationId — конфигурация из DCM
• floodlightActivityId — идентификатор флудлайта
• requestStatus — статус отправки звонка в DCM. Возможные значения:
  • success — успешная отправка
  • error — отправка, завершенная ошибкой
• requestErrors — описание ошибки отправки звонка в DCM, если она возникает. Если нет, то значение будет null.

Идентификатор посетителя Calltouch. Он представляет из себя значение нашей куки _ct. Если в звонке значение отсутствует (у лида нет сессии, например, звонок на статический номер), то в значении будет null.

Глобальный идентификатор посетителя Calltouch, общий для сайтов, на которых установлен скрипт Calltouch. Он представляет из себя значение сквозной куки _ct_client_global_id. Значение параметра в ответе формируется только при включении соответствующего сеттинга (требуется обратиться к вашему менеджеру). Если сеттинг не включен, или в звонке значение отсутствует (у лида нет сессии, например, звонок на статический номер), то в значении будет null.

The request sent by the client was syntactically incorrect — синтаксическая ошибка в запросе, подробности ошибки выводятся в выходном параметре message. Необходимо проверить корректность входных параметров.

Так же может возникать, если API-запрос осуществляется к отключенному сайту.