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

Тегирование звонков и заявок через API

Содержание

 

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

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

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

 

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

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

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

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

ID сайта Идентификатор сайта, его можно получить в настройках API личного кабинета Calltouch.
API токен Ключ доступа, его можно получить в настройках API личного кабинета Calltouch.
ID звонка или заявки Идентификатор звонка, соответствует выходному параметру callId или идентификатор заявки, соответствует выходному параметру requestID. Идентификатор можно узнать с помощью API-выгрузки звонков.
Имя тега

Теги через запятую, которые нужно присвоить лиду. Если указанного тега еще не существует в Вашем личном кабинете Calltouch, он будет создан автоматически. Если указанный тег уже существует, то будет использован уже существующий. Указывая несколько тегов, после запятой не нужно ставить пробел, иначе он окажется началом следующего тега. 

Максимальная длина тега - 100 символов.

 

Ниже представлена логика присвоения тегов в случае присутствия того или иного параметра в методе:

  • Если в методе указан callId, то тегируется звонок
  • Если в методе указан requestId, то тегируется заявка по ID заявки в Calltouch
  • Если в методе указан requestNumber, то тегируется заявка по ID заявки клиента
  • Если в методе указаны callId и requestId, то тегируется и звонок и заявка (по ID заявки в Calltouch)
  • Если в методе указаны callId и requestNumber, то тегируется и звонок и заявка (по ID заявки клиента)
  • Если в методе указаны requestId и requestNumber, то тегируется заявка сначала по requestNumber, если не найдено, то по requestId
  • Если в методе указаны callId, requestId и requestNumber, то тегируется звонок и заявка (сначала по requestNumber, если не найдено, то по requestId).
  • Если в методе не указаны ни callId, ни requestId, ни requestNumber, или указаны, но по ним не удается найти звонок или заявку, то выводится 404 ошибка с поясняющим текстом в JSON-ответе "Не указаны идентификаторы звонка callId или заявки requestId/requestNumber, либо указаны не верно".
  • Если передаваемый тег уже существует у звонка/заявки, ничего не происходит, звонок/заявка не будут протегированы еще раз

 

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

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

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

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

ID сайта Идентификатор сайта, его можно получить в настройках API личного кабинета Calltouch.
API токен Ключ доступа, его можно получить в настройках API личного кабинета Calltouch.
ID звонка Идентификатор звонка, соответствует выходному параметру callId. Идентификатор любого звонка можно узнать с помощью API-выгрузки звонков.
Имя тега

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

 

Ниже представлена логика снятия тегов в случае присутствия того или иного параметра в методе:

  • Если в методе указан callId, то снимается тег у звонка
  • Если в методе указан requestId, то снимается тег у заявки по ID заявки в Calltouch
  • Если в методе указан requestNumber, тоснимается тег у заявки по ID заявки клиента
  • Если в методе указаны callId и requestId, то снимается тег у звонка и заявки (по ID заявки в Calltouch)
  • Если в методе указаны callId и requestNumber, то снимается тег у звонка и заявки (по ID заявки клиента)
  • Если в методе указаны requestId и requestNumber, то снимается тег у заявки сначала по requestNumber, а если не найдено, то по requestId
  • Если в методе указаны callId, requestId и requestNumber, то снимается тег у звонка и заявки (сначала по requestNumber, если не найдено, то по requestId).
  • Если в методе не указаны ни callId, ни requestId, ни requestNumber, или указаны, но по ним не удается найти звонок или заявку, то выводится 404 ошибка с поясняющим текстом в JSON-ответе "Не указаны идентификаторы звонка callId или заявки requestId/requestNumber, либо указаны не верно".
  • Если снимаемый тег не существует у звонка/заявки, то ничего не происходит

 

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

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

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

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

[ { "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 будет содержать массив элементов:

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

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

name Имя тега.

 

 

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

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

web-api_tags_in_lk.png

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

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

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