Произвольное название формы на Вашем сайте, с которой отправляется заявка в Calltouch. В последствие переданное название формы отображается в одноименном столбце журнала заявок:

В качестве названия формы может быть передано строковое значение до 256 символов.

Уникальный идентификатор заявки на Вашем сайте. В качестве идентификатора может быть передано строковое значение до 256 символов. Переданный идентификатор отображается в столбце "Номер заявки" журнала заявок над названием формы:

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

Дата и время отправки заявки в формате: dd.mm.yyyy%20hh:mm:ss. Дата и время заявки отображается в одноименном столбце "Журнала заявок":

Параметр является необязательным, если его не передавать, то заявке будет автоматически присвоена текущая дата и время отправки API-запроса на создание заявки.

Идентификатор сессии Calltouch. С помощью него Calltouch присвоит переданной заявке источник перехода на сайт посетителя, отправившего ее. Идентификатор сессии Calltouch присутствует в коде сайта, с которого отправляется заявка, если в этом коде установлен скрипт отслеживания Calltouch. Чтобы получить ID сессии скрипта Calltouch или проверить отработал ли он или нет, используйте JS-функцию calltracking_params., например:

Где вместо mod_id нужно указать идентификатор скрипта Calltouch.

Определившийся источник заявки (с помощью переданного значения сессии) будет отображен в журнале заявок:

Параметр sessionId является необязательным, но если его не передавать, источник заявки не удастся определить как показано на скриншоте выше.

Произвольное имя пользователя, отправившего заявку. Переданное значение отображается в журнале заявок:

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

Номер телефона. Можно передавать в любом формате, главное чтобы было 11 цифр. Переданный номер автоматически будет приведен к формату 7XXXXXXXXXX и будет отображаться в журнале заявок:

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

Последние 4 цифры номера при необходимости могут быть скрыты сотрудникам Calltouch, см. раздел "Защита данных" в настройках статистики.

Почта клиента. Переданная почта отображается в журнале заявок:

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

Часть почты после знака @ при необходимости могут быть скрыты сотрудникам Calltouch, см. раздел "Защита данных" в настройках статистики.

Комментарий к заявке. Необязательный параметр. Произвольный текст, в качестве которого может быть передано любое необходимое значение. Переданный комментарий отображается в журнале заявок ЛК, оставленный от имени "API":

Произвольные теги. Необязательный параметр. Можно передавать несколько тегов через запятую. С помощью тегов заявки можно будет фильтровать в отчетах Calltouch.

Адрес страницы, с которой отправляется заявка. При отправке формы с сайта можно использовать переменную браузера location.href, чтобы передать в requestUrl страницу отправки формы.

Объект будет содержать вложенные объекты с описанием посещения, за которым закрепилась заявка. Описание вложенных объектов:

• keywords - ключевой запрос
• city - город посетителя (определяется по его IP-адресу)
• ip - IP-адрес
• browser - Браузер
• source - Источник перехода
• medium - Канал перехода
• ref - адрес страницы, с которой был совершен реферальный переход на Ваш отслеживаемый сайт (присутствует только если переход посетителя был реферальным)
• url - адрес входа на сайт (может отличаться от страницы, с которой в итоге был совершен звонок)
• utmSource - значение utm-метки utm_source
• utmMedium - значение utm-метки utm_medium
• utmTerm - значение utm-метки utm_term
• utmContent - значение utm-метки utm_content
• utmCampaign - значение utm-метки utm_campaign
• guaClientId - идентификатор Google Client ID (присутствует, если настроена интеграция с Google Analytics)
• yaClientId - идентификатор Yandex Client ID (присутствует, если настроена интеграция с Яндекс.Метрика)
• sessionId - идентификатор сессии Calltouch, который Вы отправили в запросе ранее
• attribution - текущая модель атрибуции, согласно которой определился источник заявки (модель атрибуции может быть изменена в системных настройках ЛК, после этого источники будут "на лету" переопределены у всех звонков и заявок ранее)
• attrs - Сторонние параметры, переданные заранее в статистику Calltouch.

Если Вы не отправляли идентификатор сессии Calltouch в запросе, объект будет равен значению null.

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

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

Объект будет содержать вложенные объекты с описанием клиента, данные по которому Вы отправили в запросе. Описание вложенных объектов:

• fio - имя клиента
• clientId - идентификатор клиента внутри Calltouch
• phones - содержит массив, внутри которого в объекте phoneNumber содержится номер телефона клиента
• contacts - содержит массив, внутри которого в объекте contactValue содержится почта клиента

• true (целевая заявка)
• false (не целевая заявка)

Обязательный параметр. В отличие от API-запроса на создание сделки, в API-запросе на их выгрузку требуется указывать токен доступа к статистике Вашего ЛК через API. Уникальный для каждого логина Вашего ЛК. Получить его можно в разделе "Настройки => API" ЛК Calltouch:

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

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

Необязательный параметр. В качестве его значения можно указать телефонный номер, для выгрузки только тех заявок, в которых был указан этот телефонный номер.

Режим фильтрации предыдущего параметра по номеру телефона, оставленного в заявке. Описание режимов смотри ниже.

Необязательный параметр. В качестве его значения можно указать электронную почту, для выгрузки только тех заявок, в которых была указана эта электронная почта.

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

Флаг истории посещений посетителя, оставившего заявку. Формат: withMapVisits=true - включить в ответ историю посещений, withMapVisits=false или отсутствие параметра - не включать.

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

Формат: withRequestTags=true - включить в ответ теги заявок, withRequestTags=false или отсутствие параметра - не включать.

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

Флаг выгрузки данных по интеграции с 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.

Комментарии к заявкам. Возможные значения: 

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

Где вложенные объекты элемента массива:

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

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

Объект будет содержать вложенные объекты с описанием посещения, за которым закрепилась заявка. Описание вложенных объектов:

• keywords - ключевой запрос
• city - город посетителя (определяется по его IP-адресу)
• ip - IP-адрес
• browser - Браузер
• source - Источник перехода
• medium - Канал перехода
• ref - адрес страницы, с которой был совершен реферальный переход на Ваш отслеживаемый сайт (присутствует только если переход посетителя был реферальным)
• url - адрес входа на сайт (может отличаться от страницы, с которой в итоге был совершен звонок)
• utmSource - значение utm-метки utm_source
• utmMedium - значение utm-метки utm_medium
• utmTerm - значение utm-метки utm_term
• utmContent - значение utm-метки utm_content
• utmCampaign - значение utm-метки utm_campaign
• guaClientId - идентификатор Google Client ID (присутствует, если настроена интеграция с Google Analytics)
• yaClientId - идентификатор Yandex Client ID (присутствует, если настроена интеграция с Яндекс.Метрика)
• sessionId - идентификатор сессии Calltouch, который Вы отправили в запросе ранее
• attribution - текущая модель атрибуции, согласно которой определился источник заявки (модель атрибуции может быть изменена в системных настройках ЛК, после этого источники будут "на лету" переопределены у всех звонков и заявок ранее)
• attrs - Сторонние параметры, переданные заранее в статистику Calltouch.

Если Вы не отправляли идентификатор сессии Calltouch в запросе, объект будет равен значению null.

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

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

Объект будет содержать вложенные объекты с описанием клиента, данные по которому Вы отправили в запросе. Описание вложенных объектов:

• fio - имя клиента
• clientId - идентификатор клиента внутри Calltouch
• phones - содержит массив, внутри которого в объекте phoneNumber содержится номер телефона клиента
• contacts - содержит массив, внутри которого в объекте contactValue содержится почта клиента

Целевая заявка. Может принимать следующие значения:

• true (целевая заявка)
• false (не целевая заявка)

Массив всех сделок, связанных с заявкой. Для каждой сделки будет содержать вложенные объекты с описанием сделки, связанной с заявкой, если таковые были созданы (см. статью Управление сделками через API). Описание вложенных объектов:

• orderId - идентификатор сделки внутри Calltouch
• dateCreated - дата и время создания сделки
• status - cтатус сделки
• sum - бюджет сделки
• orderNumber - уникальный идентификатор сделки в Вашей CRM (если при создании сделки Вы не отправляли данный параметр, в ответе будет содержаться уникальный идентификатор сделки в Calltouch - он же будет и в объекте orderId выше)

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

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

• utmSource
• sessionDate
• sessionID
• city
• ip
• utmTerm
• utmContent
• userAgent
• sessionId
• source
• medium
• utmCampaign
• url
• ref
• additionalTags
• utmMedium
• guaClientId
• keyword

Если источник звонка или заявки рекламная кампания Яндекс.Директ, между 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 фразы
  Пример ответа, когда у звонка или заявки есть эти данные:

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

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

"googleAdWords": null

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

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

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.

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