Содержание

Возможности

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

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

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

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

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

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

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

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

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

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

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

Добавление пользовательских полей

По умолчанию API-метод создания сделок (см. далее) позволяет передавать следующие метрики сделок:

• Кол-во сделок
• Их статус
• Менеджера
• Теги

Но вы можете расширить этот список до бесконечности – в настройках API личного кабинета Calltouch есть возможность создать пользовательские поля API-метода создания/выгрузки сделок:

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

• В API-методах создания/обновления/выгрузки сделок
• В пользовательских столбцах Calltouch

Например, как в ЛК Calltouch увидеть валовую прибыль? Теперь очень просто. Добавьте поле "Себестоимость" в API и выгружайте в него данные из CRM. А чтобы посчитать валовую прибыль, просто создайте пользовательский столбец, задав в нем формулу:

В этом примере созданный пользовательский столбец будет отображать валовую прибыль сделок на этапе "Счет на предоплату" менеджера Васи с тегом "Акции". Настроив один раз пользовательский столбец, он станет доступным в любом отчете Calltouch:

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

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

Запрос

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

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

API-запрос:

Где:

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

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

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

Запрос далее выгрузит сделки сайта с идентификатором 12345, созданные и по звонкам и по заявкам, дата создания (параметр orderDate в API-запросах на создание новых сделок) которых находится между 01/03/2018 и 27/03/2018. В выгрузке включена пагинация (используются параметры page и limit), а так же в ней будет присутствовать массив тегов по каждой сделке (указан флаг withOrdersTags=true).

Ответ

API-запрос выше выгружает только первую страницу выгрузки. Для выгрузки остальных страниц выгрузки, отправьте тот же запрос, но в параметре page указав необходимую страницу выгрузки. После успешной отправки API-запроса на выгрузку списка сделок, возвращается следующий JSON-ответ (пример):

{
 "page": 1,
 "pageTotal": 4,
 "pageSize": 500,
 "recordsTotal": 2000,
 "records": [
    {
        "client": {
            "phones": "74953080100",
            "fio": null
        },
        "completedAmount": null,
        "completedDate": "15/02/2018",
        "createdDate": "10/02/2018",
        "isDeleted": false,
        "manager": "Коля",
        "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"
        },
        "orderStatus": "final",
        "plannedAmount": 6000,
        "service": "AmoCRM",
        "tags": [
            "tag1",
            "tag2",
        ],
        "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",
        "isDeleted": false,
        "manager": null,
        "orderDate": "16/02/2018 10:00:00",
        "orderNumber": "7813745",
        "orderSource": {
            "requestNumber": "5231705",
            "type": "REQUEST"
        },
        "orderStatus": "start",
        "plannedAmount": 1000,
        "service": null,
        "visit": {
            "utmSource": null,
            "additionalTags": [],
            "utmTerm": null,
            "utmContent": null,
            "visitDate": null,
            "utmMedium": null,
            "source": null,
            "medium": null,
            "keyword": null,
            "utmCampaign": null
        }
    },
    ...
    {
        ...
    }
]
}

JSON-объекты:

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

 Кол-во запросов в секунду к API Calltouch ограничено – не более 5 запросов (+5 запросов в очередь) в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, 5 поставятся в очередь, и 1 API-запрос завершится с ошибкой.