Тегирование сделок, звонков и заявок через API – Calltouch - справочный центр

Содержание

Что такое теги?
Присвоение тегов звонку
Снятие тегов со звонка
Выгрузка тегов звонков
Как отображаются в статистике теги, присвоенные звонкам через API

Что такое теги?

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

Вручную в журнале звонков и журнале заявок личного кабинета Calltouch
Автоматически на основе введенных тоновых сигналов клиентом или оператором в ходе разговора
Автоматически в зависимости от номеров, на которые или с которых звонят клиенты
Автоматически системой Calltouch Predict
Автоматически системой Calltouch Антифрод
Удаленно с помощью Calltouch API

О последнем способе и пойдет речь в данной статье.

Присвоение тегов сделке или звонку или заявке

Чтобы присвоить какой-либо тег звонку, выполните запрос:

https://api.calltouch.ru/calls-service/RestAPI/{ID сайта}/addtags/?clientApiId={API токен}&callId={ID звонка}&tagnames={имя тега 1,имя тега 2,имя тега 3,...}

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

ID сайта	Идентификатор сайта, его можно получить в меню личного кабинета Calltouch в разделе «Интеграции - API и Webhooks»:
API токен	Ключ доступа, его можно получить в меню личного кабинета Calltouch в разделе «Интеграции - API и Webhooks»:
ID сделки или звонка или заявки	Идентификатор сделки, соответствует выходному параметру orderId или идентификатор звонка, соответствует выходному параметру callId или идентификатор заявки, соответствует выходному параметру requestId. Идентификатор можно узнать с помощью API-выгрузки звонков.
Имя тега	Теги через запятую, которые нужно присвоить сделке или лиду. Если указанного тега еще не существует в Вашем личном кабинете Calltouch, он будет создан автоматически. Если указанный тег уже существует, то будет использован уже существующий. Указывая несколько тегов, после запятой не нужно ставить пробел, иначе он окажется началом следующего тега. Максимальная длина тега - 100 символов.

Обратите внимание, что заявку можно тегировать так же и по requestNumber. Сделку можно тегировать так же и по orderNumber.

Снятие тегов со звонка

Чтобы снять какой-либо тег со звонка, выполните запрос:

https://api.calltouch.ru/calls-service/RestAPI/{ID сайта}/deletetags/?clientApiId={API токен}&callId={ID звонка}&tagnames={имя тега 1,имя тега 2,имя тега 3,...}

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

ID сайта	Идентификатор сайта, его можно получить в меню личного кабинета Calltouch в разделе «Интеграции - API и Webhooks»:
API токен	Ключ доступа, его можно получить в меню личного кабинета Calltouch в разделе «Интеграции - API и Webhooks»:
ID звонка или сделки или заявки	Идентификатор сделки, соответствует выходному параметру orderId или идентификатор звонка, соответствует выходному параметру callId или идентификатор заявки, соответствует выходному параметру requestId. Идентификатор любого звонка можно узнать с помощью API-выгрузки звонков.
Имя тега	Теги через запятую, которые нужно снять со звонка. Можно удалять теги, присвоенные не только через API, но и любым другим способом. При снятии тега со звонка, он не удаляется из списка тегов. Указывая несколько тегов, после запятой не нужно ставить пробел, иначе он окажется началом следующего тега.

Обратите внимание, что с заявки можно снимать теги так же и по requestNumber. Со сделок можно снимать теги так же и по orderNumber.

Выгрузка тегов звонков

Чтобы выгрузить теги звонков, воспользуйтесь API для выгрузки звонков, добавив дополнительный входной параметр withCallTags=true (для заявок withRequestTags=true, для сделок withOrdersTags=true):

https://api.calltouch.ru/calls-service/RestAPI/{ID сайта}/calls-diary/calls?clientApiId={API токен}&dateFrom=дд/мм/гггг&dateTo=дд/мм/гггг&page={Страница выгрузки}&limit={Кол-во звонков на одной странице}&withCallTags=true

С описанием остальных параметров Вы можете ознакомиться в инструкции по выгрузке звонков через API. Результат выгрузки в формате JSON будет содержать теги в выходном параметре callTags (RequestTags для заявок, tags для сделок):

[ { "date": "08/09/2017 15:25:51", "city": "moscow", "uniqueCall": false, "utmContent": "скидки", "source": "yandex", "medium": "cpc", "duration": 17, "ref": null, "additionalTags": [], "waitingConnect": 1, "ctCallerId": "77324c9f695348892ac93a4f678b0bfe", "sessionUid": "f54f9f74-8beb-11e7-ab22-23794e96cdca", "callbackCall": false, "keyword": "купить виллу в доминикане", "callClientUniqueId": null, "successful": true, "order": null, "callId": 20216888, "callTags": [ { "category": "Потенциальный клиент", "type": "MANUAL", "names": [ "Потенциальный клиент" ] }, { "category": "Новая продажа", "type": "WEB-API", "names": [ "Новая продажа" ] }, { "category": "Отдел продаж", "type": "AUTO-CT", "names": [ "Отдел продаж" ] }, { "category": "Контекстная реклама", "type": "AUTO-PN", "names": [ "Контекстная реклама" ] }, { "category": "Проверенные", "type": "AUTO-AF", "names": [ "Достоверный" ] }, { "category": "Целевой", "type": "AUTO-PR", "names": [ "Целевой" ] } ], "utmSource": "yandex", "clientId": null, "callerNumber": "79209330316", "ip": "10.10.10.10", "utmTerm": "купить виллу в доминикане", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36", "sessionId": 77023341, "utmCampaign": "виллы", "url": "https://site.ru/", "phoneNumber": "74955555555", "uniqTargetCall": false, "targetCall": false, "attribution": 1, "utmMedium": "cpc" } ]

Выходной параметр callTags (RequestTags для заявок) будет содержать массив элементов:

category

Категория тега. Ранее теги можно было объединять в категории, сейчас этот функционал устарел, но для обратной совместимости параметр оставлен в выгрузке API. Для всех новых тегов, имя категории будет равно имени тега.

type

Тип тега. Возможные значения:

AUTO-PR - теги, проставленные автоматически системой Calltouch Predict.
AUTO-AF - теги, проставленные автоматически системой Calltouch Антифрод.
AUTO_GR - теги по полу клиента, проставленные автоматически системой Calltouch Predict.
AUTO-PN - теги, проставленные автоматически в зависимости от номеров, на которые или с которых звонят клиенты.
AUTO-CT - теги, проставленные автоматически на основе введенных тоновых сигналов (DTMF) клиентом или оператором в ходе разговора.
MANUAL - теги, проставленные вручную пользователем в журнале звонков личного кабинета Calltouch.
WEB-API - теги, добавленные через API.

names

Массив, содержащий имена тегов

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

Как отображаются в статистике теги, присвоенные звонкам через API

Теги, присвоенные звонкам через API, обозначаются в журнале звонков личного кабинета Calltouch иконкой облака :

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

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