Импорт звонков

Существует 2 метода импорта звонков.

1. Пакетный импорт со сторонних площадок
2. Импорт звонков (с привязкой источника по номеру телефона и дате звонка)
   

Изучите их отличия, чтобы выбрать необходимый для ваших задач.

Первый метод:

• будет полезен, если звонки проходят не через сайт, а через сторонние площадки, которые самостоятельно фиксируют источник звонка и номера не используются в подмене на сайте
• можно передавать кастомные источники звонка без сессии, не привязанные к каким-либо номерам из настроенных пулов в личном кабинете Calltouch
• можно передавать звонки пачками
• не нужно заранее заводить номера в пулы в личный кабинет Calltouch

Второй метод:

• если используете собственные телефонные номера, настроенные в Вашей АТС, для отслеживания источников звонков на сайте, их необходимо завести в наш личный кабинет Calltouch
• кастомные источники звонков будут взяты из названия пула, настроенного в личном кабинете Calltouch
• один запрос - один звонок

Запрос на импорт

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

POST: https://api.calltouch.ru/lead-service/v1/api/call/import   

HTTP-заголовки:

• Access-Token – API-ключ
• SiteId – ID ЛК Calltouch

Тело запроса в формате JSON:

{
    "calls": [

    // Звонок 1

    {
        "referenceId": "Уникальный ID звонка",
        "sipCallId": "Уникальный ID звонка из АТС",
        "clientPhoneNumber": "Номер телефона клиента",
        "callCenterPhoneNumber": "Номер телефона, на который звонит клиент",
        "callStartTime": "Дата звонка в формате yyyy-mm-dd hh:mm:ss",
        "duration": 120,
        "waitingTime": 10,
        "status": "successful",
        "recordUrl": "Ссылка на запись звонка в формате mp3",
        "comment": {
            "text": "Комментарий"
        },
        "addTags": [
            {
               "tag": "Тег 1"
            }
        ],
        "customSources": {
            "source": "Произвольный источник",
            "medium": "Произвольный канал",
            "campaign": "Произвольная кампания",
            "content": "Произвольное объявление",
            "term": "Произвольная ключевая фраза"
        },
        "customFields": [
            {"field": "name", "value": "Вася"},
            {"field": "birthday", "value": "1990-01-01"}
        ],
        "sessionId": "ID сессии Calltouch"
    },

    // Звонок N

    ...
    
    ]
} 

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

"customFields": [
     {"field": "name", "value": "Вася"},
     {"field": "birthday", "value": "1990-01-01"}
]

Ответ на импорт

Если валидация всех параметров прошла успешно, то запускается процесс импорта звонков и в ответ отдается ID лога очереди импорта, по которому отдельным запросом можно будет узнать результат импорта, пример:

{
    "meta": [],
    "data": {
        "logId": 471
    }
}
   

Если API-токен не указан, то импорт звонков не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "message": "Ошибка доступа"
    }
}
   

Если API-токен указан не верно, то импорт звонков не выполняется и выводится ошибка:

{
 "meta": [],
 "data": {
 "message": "Ошибка доступа"
 }
}   

Если в запросе обнаруживаются ошибки валидации, то импорт звонков не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "type": "validationError",
        "apiErrorData": null,
        "validationErrorData": {
            "violations": [
                {
                    "fieldPath": "calls[0].clientPhoneNumber",
                    "message": "Значение должно быть равно 11 символам."
                }
            ]
        }
    }
}
   

Запрос на лог импорта

POST: https://api.calltouch.ru/lead-service/v1/api/call/import/log?logId={ID лога}
   

• Access-Token – API-ключ
• SiteId – ID ЛК Calltouch

GET-параметры:

• lodId – ID лога импорта звонков

Ответ на лог импорта

{
    "meta": [],
    "data": {
        "calls": [
            {
                "imported": true,
                "referenceId": "5lBNQaPvlR8IKP71",
                "sipCallId": "asdf-1234-ghk-1234",
                "callId": 2319960
            }
        ]
    }
}
   

Параметры ответа

Как это работает

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

Для настройки интеграции вам необходимо отправить заявку вашему личному аккаунт-менеджеру Calltouch либо на почту info@calltouch.net. Укажите в заявке, что вам необходимо получить логин и токен к АТС Calltouch, чтобы импортировать в нее звонки из своей АТС. Далее мы произведем необходимые настройки с нашей стороны и вышлем вам авторизационные данные (логин и токен), по которым вы сможете отправлять http-запросы в нашу АТС и создавать звонки в статистики.

Таким образом, после завершения звонка на ваш номер, ваша АТС будет должна отправлять http-запрос в наш сервис, содержащий всю информацию о поступившем звонке, а Calltouch на своей стороне будет склеивать эту информацию со своими данными о посетителе на сайте, которому был выделен в этот момент времени номер, на который поступил звонок. Таким образом Calltouch установит источник звонка.

Отправка запроса на импорт звонка в Calltouch

HTTP-запрос

https://ats.calltouch.ru/event-service/platform/{ATS_CODE}/inbound-call
   

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

Передаваемые параметры

https://ats.calltouch.ru/event-service/platform/{ATS_CODE}/inbound-call?model=telemirfact&apikey=dL9juaKJnm4kSNzDhHIxtgeb9ZCxRoDE&callid=dfjhvbskdjfvlsdkfjb1233443&callerid=74955550101&phonenumber=78126007428&destphonenumber=78126007428&date=2019-02-27%2012:03:00&duration=30&waitingtime=10&status=successful&clientdtmf=567,789&operatordtmf=123,456&callrecordurl=https://test.ru/calltouch/mp3/dialup.mp3
   

{
"success": true,
"eventId": 61924734
}
   

https://ats.calltouch.ru/event-service/platform/{ATS_CODE}/inbound-call?model=sessionfact&apikey=dL9juaKJnm4kSNzDhHIdfkvj&callid=dfjh21234245vbskdj245fvdfvdfsv&callerid=74955550101&ctSessionId=12312424234&siteId=6969&date=2019-02-27%2012:03:00&duration=30&waitingtime=10&status=successful&clientdtmf=567,789&operatordtmf=7&callrecordurl=https://alftest.ru/calltouch/mp3/dialup.mp3
    

<html>
<head>
<title>Error</title>
</head>
<body>Access Denied</body>
</html>
   

"success": false,
"errors": {
"destphonenumber": [
"Номер телефона 7XXXXXXXXXX не найден"
]
}
}
   

{
"success": false,
"errors": {
"duration": [
"Wrong format"
],
"waitingtime": [
"Missing data for required field"
]
}
}
   

{
"success": false
}
   

5. Не найден ID сайта или ID сессии, звонок в котором необходимо создать.

{
"success": false,
"errors": {
"ctSessionId": [
"Сессия 191834719834 не найдена"
]
}
}

{
"success": false,
"errors": {
"siteId": [
"Сайт 1223 не найден"
]
}
}
   

Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch