Наверх
Подписаться

Управление сделками через API

Содержание

 

 

Возможности

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

 

 

Отображение сделок в статистике

Созданные сделки отображаются в ЛК в виде метрик пользовательских столбцов в категории "Сделки из CRM":

custom_columns_completed_deals.jpg

С помощью пользовательских столбцов Вы можете любым необходимым Вам образом проанализировать статистику по сделкам, не только увидев их количество, как настроено на скриншоте выше, но и например просчитав возврат инвестиций ROI:

custom_columns_roi.jpg

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

На скриншоте ниже изображен пример из отчета Яндекс.Директ с двумя пользовательским столбцами: "Кол-во завершенных сделок из API" и "ROI":

custom_columns_roi_in_report.jpg

advice_ver2.png Стандартная формула расчета ROI:

(доход - расход) / расход * 100%

Применяя ее к реалиям ЛК Calltouch, в пользовательских столбцах эта формула настраивается следующим образом:

  • По рекламе Google AdWords и открытым сделкам:
    (Сделки из CRM: Сумма по открытым - Google AdWords: Бюджет) / Google AdWords: Бюджет
  • По рекламе Google AdWords и завершенным сделкам:
    (Сделки из CRM: Сумма по завершенным - Google AdWords: Бюджет) / Google AdWords: Бюджет
  • По рекламе Яндекс.Директ и открытым сделкам:
    (Сделки из CRM: Сумма по открытым - Яндекс.Директ: Бюджет) / Яндекс.Директ: Бюджет
  • По рекламе Яндекс.Директ и завершенным сделкам:
    (Сделки из CRM: Сумма по завершенным - Яндекс.Директ: Бюджет) / Яндекс.Директ: Бюджет

Умножение на 100% не нужно добавлять в формулу при настройке ее в пользовательском столбце - умножение на 100% будет автоматическое, если выбран формат "Процент".

 

 

API-метод для создания новых сделок

Запрос с указанием ID звонка или заявки

Если Вам заранее известен внутренний ID Calltouch звонка (callId) или заявки (requestId) или внешний ID заявки (requestNumber), то Вы можете создать сделку по звонку или заявке, используя API-запрос ниже. Заранее получить внутренние ID звонков можно с помощью вебхуков или API-метода для выгрузки звонков, заранее получить внутренние ID заявок можно с помощью API-метода для выгрузки заявок. Внешние ID заявок можно передавать в Calltouch на этапе создания заявок через API.

Поддерживаемые методы отправки: GET и POST.

API-запрос:

https://api-nodeX.calltouch.ru/calls-service/RestAPI/orders/register/

Где X - номер API-сервера, где расположен Ваш сайт. Его предварительно можно узнать с помощью отдельного API-метода.

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

Параметр Описание
clientApiId

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

api-token.png

callId или requestId или requestNumber

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

  • callId
    Если сделка создается по звонку, необходимо передавать идентификатор звонка.
  • requestId
    Если сделка создается по заявке и известен ID заявки внутри Calltouch, необходимо передавать этот идентификатор заявки.
  • requestNumber
    Если сделка создается по заявке и ID заявки внутри Calltouch неизвестен, но известен внешний ID заявки с сайта (он был ранее одновременно передан с сайта в Calltouch и в вашу систему, см. параметр requestNumber в API-методе создания заявок) необходимо передавать этот идентификатор заявки.

Нельзя создать сделку одновременно по звонку и заявке. Либо только по звонку, либо только по заявке. Сделка не может быть привязана одновременно ко звонку и к заявке. Если Вы вовсе не отправите ни callId ни requestId ни requestNumber, то сделка будет создана в статистике Calltouch, но во всех отчетах будет отображаться без источника, т.к. источником сделки является источник звонка или заявки, за которым она закреплена.

orderNumber

Уникальный ID сделки на стороне Вашей CRM (не на стороне Calltouch). Параметр является необязательным. Рекомендуем использовать минимум 8-значные буквенно-цифровые идентификаторы (см. пример в запросе далее). Если параметр не указан, то по умолчанию он будет равен orderId (ID сделки в Calltouch), который Calltouch вернет в ответе на запрос (см. JSON-ответ далее).

Обратите внимание! Если Вы отправляете какое-либо значение orderNumber, то для каждой новой сделки это значение обязательно должно быть уникальным.

orderSum Бюджет сделки в рублях. Обязательный параметр.
orderStatus

Статус сделки. Обязательный параметр. Возможные значения:

  • PENDING - Сделка открыта
  • COMPLETED - Сделка завершена
orderDate Дата создания сделки. Обязательный параметр. Формат dd.mm.yyyy%20hh:mm:ss.
offeredDate

Дата завершения сделки. Формат dd.mm.yyyy%20hh:mm:ss.

Обратите внимание! Дату завершения необходимо отправлять только если Вы сразу создаете сделку в статусе "Завершена": orderStatus=COMPLETED.

 

Примеры GET-запросов на создание сделки

  • Открытая сделка по звонку

Запрос далее создаст открытую сделку на сумму 1000 руб по звонку с идентификатором 32496964:

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&callId=32496964&orderNumber=K2TU/sm{7u4X3F&orderSum=1000&orderStatus=PENDING&orderDate=26.03.2018%2010:00:00
  • Закрытая сделка по звонку

Запрос далее создаст закрытую сделку на сумму 2000 руб по звонку с идентификатором 6552135. Предполагается, что сделка была создана в Вашей CRM 26.03.2018 10:00:00 (orderDate), а закрыта 27.03.2018 14:00:00 (offeredDate).

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&callId=6552135&orderNumber=xTwMzUJSPHYZrD&orderSum=2000&orderStatus=COMPLETED&orderDate=26.03.2018%2010:00:00&offeredDate=27.03.2018%2014:00:00
  • Открытая сделка по заявке

Запрос далее создаст открытую сделку на сумму 1000 руб по заявке с идентификатором 51213218:

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&requestId=51213218&orderNumber=hzwe4iCHiwauun&orderSum=1000&orderStatus=PENDING&orderDate=26.03.2018%2010:00:00
  • Закрытая сделка по заявке

Запрос далее создаст закрытую сделку на сумму 2000 руб по заявке с идентификатором 23243338. Предполагается, что сделка была создана в Вашей CRM 26.03.2018 10:00:00 (orderDate), а закрыта 27.03.2018 14:00:00 (offeredDate).

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&requestId=23243338&orderNumber=Oqu4r2BbNDOldI&orderSum=2000&orderStatus=COMPLETED&orderDate=26.03.2018%2010:00:00&offeredDate=27.03.2018%2014:00:00

advice_ver2.png Что перевести открытую сделку в закрытую, воспользуйтесь API-методом для обновления сделок далее.

 

Запрос с указанием номера телефона клиента

В случае, если заранее получить ID звонка (с помощью вебхуков или API-метода для выгрузки звонков) не предоставляется возможным, то сделку можно склеить со звонком по номеру телефона (параметр phoneNumber далее), с которого звонил клиент, и дате создания сделки по этому звонку (параметр orderDate далее). Склейка по номеру телефона по умолчанию выключена - для ее включения Вам необходимо отправить заявку Вашему аккаунт-менеджеру Calltouch либо на почту info@calltouch.net. Данная опция доступна только для звонков, не для заявок. После включения, склейка звонка со сделкой по номеру телефона клиента и дате создания сделки по нему, будет производиться в течение 10 минут после отправки API-запроса.

advice_ver2.png Мы рекомендуем использовать более точный API-метод создания сделки с указанием ID звонка или заявки.

Поддерживаемые методы отправки: GET и POST.

API-запрос:

https://api-nodeX.calltouch.ru/calls-service/RestAPI/orders/register/

Где X - номер API-сервера, где расположен Ваш сайт. Его предварительно можно узнать с помощью отдельного API-метода.

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

Параметр Описание
clientApiId

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

api-token.png

orderNumber

Уникальный ID сделки на стороне Вашей CRM (не на стороне Calltouch). Параметр является необязательным. Рекомендуем использовать минимум 8-значные буквенно-цифровые идентификаторы (см. пример в запросе далее). Если параметр не указан, то по умолчанию он будет равен orderId (ID сделки в Calltouch), который Calltouch вернет в ответе на запрос (см. JSON-ответ далее).

Обратите внимание! Если Вы отправляете какое-либо значение orderNumber, то для каждой новой сделки это значение обязательно должно быть уникальным.

phoneNumber Номер телефон, с которого звонил клиент, в формате 7XXXXXXXXXX. По этому номеру будет выполняться поиск звонка, в пределах даты, указанной в параметре orderDate и погрешности поиска, указанной в параметре linkTimeThreshold.
linkTimeThreshold

Погрешность в секундах для поиска ближайшего звонка, связанного со сделкой по дате и времени ее создания (параметр orderDate). Если не указывать параметр, по умолчанию погрешность будет равна 7200 сек (2 часа). Алгоритм связывания звонка со сделкой будет следующим:

Дата и время звонка <= Дата и время создания сделки <= Дата и время звонка + Длительность звонка + linkTimeThreshold

Например, звонок, длительностью в 5 мин, был совершен (в статистике Calltouch отображается и учитывается время начала звонка) в 17:00:00, сделка по которому была создана в CRM в 17:10. Чтобы связать такой звонок со сделкой, должны выполнится условия:

Дата и время звонка 17:00:00 <= Дата и время создания сделки 17:10:00 <= Дата и время звонка 17:00 + 5 мин + linkTimeThreshold=600 сек (10 мин)

Здесь linkTimeThreshold мог быть указан и меньше, либо вовсе не указан (тогда бы было 2 часа). Главное, чтобы время поиска ближайшего звонка для связи со сделкой в 17:10 захватывало время этого звонка в 17:00.

personalPhone Флаг необходимости склейки звонка со сделкой по номеру телефона и дате создания сделки по нему. Необходимо передавать значение true.
orderSum Бюджет сделки в рублях. Обязательный параметр.
orderStatus

Статус сделки. Обязательный параметр. Возможные значения:

  • PENDING - Сделка открыта
  • COMPLETED - Сделка завершена
orderDate Дата создания сделки. Обязательный параметр. Формат dd.mm.yyyy%20hh:mm:ss.
offeredDate

Дата завершения сделки. Формат dd.mm.yyyy%20hh:mm:ss.

Обратите внимание! Дату завершения необходимо отправлять только если Вы сразу создаете сделку в статусе "Завершена": orderStatus=COMPLETED.

 

Примеры GET-запросов на создание сделки

  • Открытая сделка по звонку

Запрос далее создаст открытую сделку на сумму 1000 руб по звонку с номера 79205550055, сделка по которому создана 25.03.2018 11:00:00. Поиск звонка для склейки со сделкой будет произведен в пределах 600 сек (10 мин) от даты создания сделки.

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&orderNumber=J2eTSacsKduifb&orderSum=1000&orderStatus=PENDING&orderDate=25.03.2018%2011:00:00&personalPhone=true&phoneNumber=79205550055&linkTimeThreshold=600
  • Закрытая сделка по звонку

Запрос далее создаст закрытую сделку на сумму 2000 руб по звонку с номера 79208880088, сделка по которому создана 25.03.2018 11:00:00, а закрыта 27.03.2018 14:00:00. Поиск звонка для склейки со сделкой будет произведен в пределах 2 часов (т.к. параметр linkTimeThreshold не указан) от даты создания сделки.

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&orderNumber=6mxA7uGxaRB5tp&orderSum=2000&orderStatus=COMPLETED&orderDate=25.03.2018%2011:00:00&offeredDate=27.03.2018%2014:00:00&personalPhone=true&phoneNumber=79208880088

 

Формат тела запроса при использовании метода POST

При использовании метода отправки POST, параметры из таблицы выше должны быть перечислены в формате "application/x-www-form-urlencoded":

параметр1=значение1&параметр2=значение2&...

При использовании метода POST, одним API-запросом можно создать только одну сделку.

 

Ответ

После успешной отправки API-запроса на создание сделки, возвращается следующий JSON-ответ (пример):

{
    "orderId": 7811141,
    "callId": 32940789,
    "dateCreated": 1522047600000,
    "status": "PENDING",
    "realSum": null,
    "offered": null,
    "sent": "26.03.2018",
    "sum": "1000",
    "isMarked": null,
    "commentsCount": 0,
    "currentAmount": 1000,
    "orderNumber": "xX8H9MkFIzpLmT"
}

JSON-объекты:

Объект Описание
orderId Идентификатор созданной сделки внутри Calltouch.
callId

Если сделка создается по звонку, в данном объекте будет идентификатор этого звонка, который Вы отправили в запросе. Если сделка создается по заявке, requestId в JSON-ответе отсутствует.

dateCreated Дата и время создания сделки, отправленные Вами в параметре orderDate запроса.
status Статус сделки, отправленный Вами в параметре orderStatus запроса.
sum Бюджет сделки, отправленный Вами в параметре orderSum запроса.
orderNumber Уникальный идентификатор сделки в Вашей CRM, который Вы отправили в параметре orderNumber запроса. Если Вы не отправляли данный параметр, в ответе будет содержаться уникальный идентификатор сделки в Calltouch (он же будет и в объекте orderId далее).

 

advice_ver2.pngJSON-объекты, не описанные выше, но присутствующие в ответе - являются устаревшими, их следует игнорировать в ответе.

 

 

API-метод для обновления существующих сделок

Запрос

API-метод необходим для перевода сделки из открытой в закрытую и изменению ее бюджета.

Поддерживаемый метод отправки: GET.

API-запрос:

https://api-nodeX.calltouch.ru/calls-service/RestAPI/orders/update-by-id/

Где X - номер API-сервера, где расположен Ваш сайт. Его предварительно можно узнать с помощью отдельного API-метода.

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

Параметр Описание
clientApiId

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

api-token.png

orderId
или
orderNumber

Идентификаторы сделки, информацию по которой требуется обновить.

Обновление информации по сделке происходит по одному из этих идентифкаторов по следующей логике:

  • Если в API-запросе обновления сделки указан параметр orderId и не указан orderNumber, то поиск сделки для обновления производится по значению из orderId.
  • Если в API-запросе обновления сделки указан параметр orderNumber и не указан orderId, то поиск сделки для обновления производится по значению из orderNumber.
  • Если в API-запросе обновления сделки одновременно указаны параметры orderNumber и orderId, то поиск сделки для обновления производится по значению из orderId. Если по значению из orderId сделка не была найдена, то поиск идет по значению в orderNumber.
  • Если в API-запросе обновления сделки не указан ни параметр orderNumber, ни параметр orderId, или указаны, но найти сделку по их значениям не удалось, возвращается ошибка 400 Bad Request.

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

orderSum Бюджет сделки в рублях. Укажите новый бюджет, если необходимо обновить его, или не передавайте параметр, если бюджет сделки не изменился.
status Укажите значение COMPLETED, если необходимо закрыть сделку (требуется так же указать и параметр offeredDate ниже). Если статус сделки не поменялся, параметр передавать не нужно.
offeredDate Укажите дату закрытия сделки в формате dd.mm.yyyy%20hh:mm:ss, если необходимо закрыть сделку (требуется так же указать и параметр status выше). Если статус сделки не поменялся, параметр передавать не нужно.

 

Пример GET-запроса на закрытие открытой сделки

Запрос далее закроет открытую сделку с идентификатором 3413448, при этом обновив ее бюджет до 100000 руб. Дата закрытия сделки 27.03.2018 16:00:00.

https://api-node3.calltouch.ru/calls-service/RestAPI/orders/update-by-id/?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&orderId=3413448&orderSum=100000&status=COMPLETED&offeredDate=27.03.2018%2016:00:00

 

Ответ

После успешной отправки API-запроса на обновление сделки, возвращается следующий JSON-ответ (пример):

    "order": {
        "orderId": 7812899,
        "callId": 32948652,
        "dateCreated": 1522047600000,
        "status": "COMPLETED",
        "realSum": null,
        "offered": "27.03.2018",
        "sent": "26.03.2018",
        "sum": "6000.0000",
        "isMarked": null,
        "commentsCount": 0,
        "currentAmount": null,
        "orderNumber": "7812899"
    },
    "client": {
        "fio": null,
        "clientId": 37674333,
        "phones": [
            {
                "phoneNumber": "74953080100",
                "phoneType": "WORK"
            }
        ],
        "contacts": null
    },
    "orderComments": "",
    "session": {
        "keywords": "(not set)",
        "city": "vladimir",
        "ip": "95.66.182.68",
        "browser": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0",
        "source": "(direct)",
        "medium": "(none)",
        "ref": "",
        "url": "http://filipok.io/calltouch/?attrs={\"attrh\":1,\"ver\":171110,\"r7k12_si\":479775180}",
        "utmSource": "",
        "utmMedium": "",
        "utmTerm": "",
        "utmContent": "",
        "utmCampaign": "",
        "guaClientId": "",
        "sessionId": 1846408120,
        "additionalTags": [],
        "attribution": 1
    }
}

JSON-объекты:

Объект Описание
order

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

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

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

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

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

  • 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)
  • sessionId - идентификатор сессии Calltouch, который Вы отправили в запросе ранее
  • attribution - текущая модель атрибуции, согласно которой определился источник заявки (модель атрибуции может быть изменена в системных настройках ЛК, после этого источники будут "на лету" переопределены у всех звонков и заявок ранее)

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

 

advice_ver2.pngJSON-объекты, не описанные выше, но присутствующие в ответе - являются устаревшими, их следует игнорировать в ответе.

 

 

API-метод для выгрузки списка сделок

Запрос

С помощью данного API-метода Вы можете выгрузить список сделок за указанный временной интервал с детальной информацией по каждой.

Поддерживаемый метод отправки: GET.

API-запрос:

https://api-nodeX.calltouch.ru/calls-service/RestAPI/{site_id}/orders-diary/orders

Где:

  • X - номер API-сервера, где расположен Ваш сайт. Его предварительно можно узнать с помощью отдельного API-метода.
  • {site_id} - ID Вашего сайта внутри ЛК Calltouch. Указывается без фигурных скобок. Его можно получить в разделе "Настройки => API":
site_id.png

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

Параметр Описание
clientApiId

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

api-token.png

dateFrom Начальная дата создания сделок (параметр orderDate в API-запросах для создания сделок выше), с которой будут выгружены сделки. Формат dd/mm/yyyy.
dateTo Конечная дата создания сделок (параметр orderDate в API-запросах для создания сделок выше), до которой будут выгружены сделки. Формат dd/mm/yyyy.
orderSource

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

  • CALL - будут выгружены сделки, созданные только по звонкам
  • REQUEST - будут выгружены сделки, созданные только по заявкам
phoneNumber.value Необязательный параметр. Параметр, с помощью которого можно выгрузить только те сделки, номер телефона клиента в которых совпадает с указанным значением.
bindTo

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

  • createddate - по дате создания самих сделок (по умолчанию)
  • offereddate - по дате завершения самих сделок
  • session - выгрузка сделок по дате сессий звонков или заявок, за которыми они закреплены

 

Пример GET-запроса на выгрузку сделок

Запрос далее выгрузит сделки сайта с идентификатором 12345, созданные и по звонкам и по заявкам, дата создания (параметр orderDate в API-запросах на создание новых сделок) которых находится между 01/03/2018 и 27/03/2018.

https://api-node3.calltouch.ru/calls-service/RestAPI/12345/orders-diary/orders?clientApiId=GllU3tbwhrTkA1Chryud4xIT48WE8FPeNyrGQQswIb3nr&dateFrom=01/03/2018&dateTo=27/03/2018

 

Ответ

После успешной отправки API-запроса на выгрузку списка сделок, возвращается следующий JSON-ответ (пример):

[
    {
        "client": {
            "phones": "74953080100",
            "fio": null
        },
        "completedAmount": null,
        "completedDate": "15/02/2018",
        "createdDate": "10/02/2018",
        "orderDate": "10/02/2018 10:00:00",
        "orderNumber": "HLlHwLqSms5r8e",
        "orderSource": {
            "callId": 32949495,
            "duration": 8,
            "phoneNumber": "74991121187",
            "type": "CALL",
            "ani": "74953080100",
            "dateCall": "27/03/2018 15:42:04"
        },
        "plannedAmount": 6000,
        "visit": {
            "utmSource": "",
            "additionalTags": [],
            "utmTerm": "",
            "utmContent": "",
            "visitDate": "27/03/2018 15:37:58",
            "utmMedium": "",
            "source": "(direct)",
            "medium": "(none)",
            "keyword": "(not set)",
            "utmCampaign": ""
        }
    },
    {
        "client": {
            "phones": "79205550058",
            "fio": "Вася"
        },
        "completedAmount": null,
        "completedDate": null,
        "createdDate": "16/02/2018",
        "orderDate": "16/02/2018 10:00:00",
        "orderNumber": "7813745",
        "orderSource": {
            "requestNumber": "5231705",
            "type": "REQUEST"
        },
        "plannedAmount": 1000,
        "visit": {
            "utmSource": null,
            "additionalTags": [],
            "utmTerm": null,
            "utmContent": null,
            "visitDate": null,
            "utmMedium": null,
            "source": null,
            "medium": null,
            "keyword": null,
            "utmCampaign": null
        }
    },
    ...
    {
        ...
    }
]

JSON-объекты:

Объект Описание
client

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

  • phones - номер клиента в формате 7XXXXXXXXXX.
  • fio - имя клиента
completedDate Дата закрытия сделки в формате dd/mm/yyyy (эта дата была передана в параметре offeredDate в API-запросе на создание закрытой сделки). Если сделка открыта - дата закрытия отсутствует.
orderDate Дата создания сделки в формате dd/mm/yyyy hh:mm:ss (эта дата была передана в параметре orderDate в API-запросе на создание открытой или закрытой сделки).
orderNumber Уникальный идентификатор сделки в Вашей CRM, который Вы отправили в параметре orderNumber API-запроса на создание новой сделки. Если Вы не отправляли данный параметр, в ответе будет содержаться уникальный идентификатор сделки в Calltouch.
orderSource

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

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

  • callId - уникальный идентификатор звонка в Calltouch
  • duration - длительность звонка в секундах
  • phoneNumber - отслеживаемый номер, на который звонил клиент, в формате 7XXXXXXXXXX
  • type - тип обращения, за которым закреплена сделка, в данном случае значение CALL
  • ani - номер клиента в формате 7XXXXXXXXXX
  • dateCall - дата и время звонка в формате dd/mm/yyyy hh:mm:ss

Описание вложенных объектов, если сделка закреплена за заявкой:

  • requestNumber - уникальный идентификатор заявки в Calltouch
  • type - тип обращения, за которым закреплена сделка, в данном случае значение REQUEST
plannedAmount Бюджет сделки
visit Объект будет содержать вложенные объекты с описанием источника звонка или заявки, за которой закреплена сделка. Описание вложенных объектов:
    • keywords - ключевой запрос
    • source - Источник перехода
    • medium - Канал перехода
    • utmSource - значение utm-метки utm_source
    • utmMedium - значение utm-метки utm_medium
    • utmTerm - значение utm-метки utm_term
    • utmContent - значение utm-метки utm_content
    • utmCampaign - значение utm-метки utm_campaign
    • visitDate - дата посещения в формате dd/mm/yyyy hh:mm:ss

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

 

advice_ver2.pngJSON-объекты, не описанные выше, но присутствующие в ответе - являются устаревшими, их следует игнорировать в ответе.

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 2 из 2
Еще есть вопросы? Отправить запрос

0 Комментарии

Войдите в службу, чтобы оставить комментарий.