Содержание
Об интеграции
Помимо готовых интеграций с CPA-площадками, например, с Marketcall, Вы можете настроить интеграцию с любой другой площадкой в разделе "Интеграции => Рекламные системы => CPA-площадки":
Интеграция позволит вам видеть в отчетах Calltouch затраты на вашу площадку и весь объем звонков по ней. Звонки будут разбиты на статусы в виде тегов, расход можно будет посмотреть как отдельно по каждому звонку в журнале звонков, так и в целом по каналу cpa в отчете по площадкам. Из CPA-площадки помимо расходов можно так же выгружать теги и комментарии ко звонкам.
Общий порядок настройки интеграции
1. Настройка статических номеров
В ВАТС создайте статические офлайн номера, обязательно указав у них источник, канал и кампанию CPA-площадки. Пример:
На эти статические номера Calltouch должны быть настроена переадресации с номеров CPA-площадки.
2. Настройка интеграции с площадкой
В настройках ЛК Calltouch ниже добавьте площадку, с который вы хотите интегрироваться. Для этого укажите:
- Название площадки
Название площадки должно быть точно таким же, как в параметре platformName постбэка - Список статических офлайн пулов
Выберите существующие офлайн пулы, настроенные на 1ом шаге, для их связи с данной CPA-площадкой. Поиск звонков по входящим запросам из CPA-площадки будет осуществляться только среди звонков на выбранные статические офлайн пулы. За одной CPA-площадкой может быть закреплено несколько статических офлайн пулов, но один и тот же пул можно одновременно закрепить только за одной CPA-площадкой.
Пример.
Предположим, у вас есть одна CPA-площадка "Тест1", там у вас настроено 10 разных объявлений, и для каждого из них вам нужен отдельный статический номер. Для этого вы у нас в ЛК настраиваете одну CPA-площадку, и закрепляете за ней 10 статических номеров.
Потом у вас появляется еще одна CPA-площадка Тест2, для нее вам тоже нужны статические номера. Но вы не можете использовать те 10 статических номеров, которые уже настроены для первой площадки, вам нужно будет подключать другие.
Вот и получается, что вы можете использовать сколько угодно разных статических номеров для одной и той же площадки, но не можете использовать один и тот же статический номер для разных площадок.
- ID офферов
Перечислите все офферы внутри ваших аккаунтов площадки, входящие постбэки по которым необходимо склеивать со звонками Calltouch по номеру телефона и дате/времени. Можно перечислить любое количество офферов через запятую без пробелов. Если в параметре offerId постбэка окажется один из ID офферов ниже, то данные из постбэка будут склеены со звонком Calltouch. - Статусы звонков
Перечислите все статусы звонков в площадке, которые будут прилетать к нам в параметре state постбэка, и соответствующие им статусы, которыми будут тегироваться звонки в Calltouch, найденные по номеру телефона и дате/времени из постбэка. Отметьте в первом столбце те статусы, по которым будет импортироваться расход из параметра price постбэка в отчет по площадкам. Выбор влияет только на отчет по площадкам, при этом в журнале звонков/лидов расход можно будет увидеть в любом статусе, даже на неотмеченном ниже.
Вы можете настроить неограниченное кол-во интеграций с разными площадкам.
3. Настройка вебхука в ЛК площадки
В настройках ЛК площадки настройте исходящий постбэк (вебхук) по звонку.
Параметры постбэка
Адрес сервера:
События, по которым отправлять постбэк:
CPA-площадка должна отправлять постбэк на сервер Calltouch из своего ЛК:
- При получение нового звонка.
- При обновление информации (статуса, расхода, тегов, комментария) по существующему звонку. В этом случае platformCallId должен быть тот же самый, что был передан при получение нового звонка – по нему будет найден уже ранее импортированный звонок, по которому произойдет обновление данных.
Метод: POST
Тело запроса: JSON
Пример тела запроса:
"platformName": "cpaservice1",
"siteId": 36024,
"platformCallId": "bW4NyCgNKlXCKE9N",
"state": "test",
"tags": "Новый тег",
"comment": "Новый коммент",
"price": "1500",
"currency": "rub",
"clientPhone": "79208891106",
"date": "1593077100",
"offerId": "2343542"
}
Описание параметров
Параметр | Формат | Обязательный | Описание |
platformName | Строка, любые символы | Да | Имя CPA-площадки, которое было указано в настройках ЛК Calltouch. |
siteId | Число | Да | ID личного кабинета Calltouch. Его можно скопировать из адресной строки ЛК после sites/123/ – где 123 и будет ID ЛК. |
platformCallId | Строка, любые символы | Да | Уникальный идентификатор звонка внутри CPA-площадки. |
state | Строка, любые символы | Да | Статус звонка. Можно перечислить через запятую любое кол-во статусов. |
tags | Строка, любые символы | Нет | Теги звонка. Можно перечислить через запятую любое кол-во тегов. |
comment | Строка, любые символы | Нет | Комментарий ко звонку. |
price | Рациональное положительное число, целая часть отделяется точкой, максимум два знака после точки | Да | Стоимость звонка |
currency | Валюта | Да | rub или usd |
clientPhone | 7xxxxxxxxxx | Да | Номер телефона клиента, с которого он звонил |
date | Timestamp | Да | Дата звонка |
offerId | Строка, любые символы | Да | ID оффера |
Все параметры выше, кроме siteId, в JSON передаются в формате строки (string).
Как будет работать интеграция
CPA-площадка при получение нового или при обновление информации по существующему звонку отправляет постбэк в Calltouch. Если в постбэке содержится название площадки platformName и ID оффера offerId, настроенных в интеграции ЛК Calltouch siteId, то по номеру телефона clientPhone и дате/времени звонка date идет поиск звонка в ЛК Calltouch. Поиск идет только среди выбранных статических офлайн номеров в настройках интеграции и в пределах +/- 15 мин от указанной даты/времени в date. Найденный звонок тегируется в статистике статусами из CPA-площадки и по нему импортируются расходы. Дополнительно могут быть также переданы обычные теги и комментарии. Теги статусов можно будет увидеть в журнале звонков, расходы можно будет увидеть в журнале звонков по каждому звонку:
Если у вас подключено несколько CPA-площадок, то чтобы узнать название площадки, по которой были импортированы данные, откройте звонок и блоке "Информация" будет указано название площадки:
Присвоение/обновление расхода звонкам в журнале звонков/лидов выполняется в режиме онлайн, как только прилетел постбэк от площадки.
Импортированные расходы на выбранных в настройках ЛК статусах проливаются также в отчет по площадкам в разрезе источников трафика, которые были указаны в настройках отображения статических номеров на 1ом шаге:
Данные в отчет по площадкам, в отличие от журнала звонков, проливаются 1 раз в сутки за предыдущий день или за день, в котором нужно пересчитать данные, если они приходят задним числом в постбэке. Поэтому данные из отправленных сегодня постбэков из CPA-площадки появятся в отчете по площадкам только на следующий день. Расходы импортируются в отчет по площадкам только если звонок находится на выбранном в настройках интеграции статусе. Расход может обновиться задним числом по постбэку из CPA-площадки.