Серверное Callback API

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

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

Для подключения необходимо:

1. Пополнить баланс минут и активировать услугу обратного звонка.
2. Создать специальный тип виджета Автопрозвон заявок с сайта.
3. Включить виджет.
4. Настроить передачу заявок с сервера с помощью серверного API.

Далее представлены варианты передаваемых параметров для отправки заявок на обратный звонок

Запрос

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

https://api.calltouch.ru/widget-service/v1/api/widget-request/user-form/create

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

Пример тела запроса

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

{
    "routeKey": "Ключ виджета "Автопрозвон заявок с сайта", к которому будет привязана заявка",
    "phone": "Номер телефона клиента",
    "fields": [
      {
        "type": "Название типа (text, email, name)",
        "name": "Название произвольного поля",
        "value": "Значение произвольного поля"
      }
    ],
    "sessionId": "ID сессии Calltouch",
    "scheduleTime": "Время, на которое заказали обратный звонок, в формате
      yyyy-mm-dd hh:mm:ss (например 2020-10-01 02:10:00)",
    "utmSource": "Произвольный источник",
    "utmMedium": "Произвольный канал",
    "utmCampaign": "Произвольная кампания",
    "utmContent": "Произвольное объявление",
    "utmTerm": "Произвольная ключевая фраза",
    "callUrl": "URL-адрес страницы, с которой была отправлена заявка",
    "tags": [
      "Тег 1"
    ],
    "unitId": Идентификатор отдела в виджете "Автопрозвон заявок с сайта"
}

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

"tags": [ "Тег 1", "Тег 2" ]

Пример запроса

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

POST /widget-service/v1/api/widget-request/user-form/create HTTP/1.1
Host: api.calltouch.ru
Access-Token: <token>
...

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

{"routeKey": "routekey_1", "phone": "79992223344"}

Пример со всеми параметрами представлен ниже:

{
   "routeKey": "routekey_1",
   "phone": "79992223344",
   "fields": [
     {"type": "name", "name": "Имя", "value": "Иван"},
     {"type": "text", "name": "Фамилия", "value": "Иванов"},
     {"type": "text", "name": "Отчество", "value": "Иванович"},
     {"type": "email", "name": "Почта", "value": "test@test.ru"},
     {"type": "text", "name": "Тема", "value": "Заявка на консультацию"}
     ],
    "sessionId": "11223344", 
    "scheduleTime": "2021-02-01 17:10:00",
    "utmMedium": "medium",
    "utmSource": "source",
    "utmCampaign": "campaign",
    "utmContent": "content",
    "utmTerm": "term",
    "tags": [
      "tag1","tag2","tag3","tag10"
    ],
    "unitId": 112233
}

Для работы с API необходимо в заголовке запроса указать токен, который можно получить в разделе личного кабинета:  Интеграции / Отправка данных во внешние системы / API и Webhooks / API.

Для получения id сессии необходимо воспользоваться одним из способов:

1. Получение id сессии из скрипта подмены.

Идентификатор сессии Calltouch присутствует в коде сайта, с которого отправляется заявка, если в этом коде установлен скрипт отслеживания Calltouch. Чтобы получить ID сессии скрипта Calltouch, или проверить отработал ли он или нет, используйте JS-функцию calltracking_params, например:

window.ct('calltracking_params','mod_id').sessionId

Где вместо mod_id нужно указать идентификатор скрипта Calltouch.

2. Получение id сессии из cookies.

Приведем пример реализации скрипта на PHP с использованием CURL:

$sessionId = $_COOKIE['_ct_session_id'];

В обоих случаях определившийся источник заявки на обратный звонок (с помощью переданного значения сессии) будет отображен в журнале звонков:

Более полное описание метода /api/widget-request/user-form/create представлено по ссылке http://api.calltouch.ru/widget-service/v1/

Данная документация отображает технические параметры запроса, а также предоставляет возможность отправки тестовых заявок на прозвон виджетом "Автопрозвон заявок с сайта".

Для просмотра необходимо перейти в параметры заявки:

Чтобы отправить тестовую заявку, необходимо, авторизоваться, используя API-токен проекта, к которому вы планируете подключиться по API:

Для ознакомления с описанием метода и просмотра массива можно открыть каждый метод отдельно (строки кликабельны):

Для просмотра примера воспользуйтесь блоком "Example Value" и кнопкой Try it out + Execute.

Вы увидите ответ с описанием кода:

Через данный блок, при использовании рабочего токена и routeKey, можно создать боевую заявку, которая будет обработана через сервис обратного звонка:

Для просмотра списка полей перейдите в блок Model.
Ниже список полей для создания заявки на обратный звонок:

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