Авторизация (токен)

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

Токен необходимо передавать в заголовке запроса Access-Token.

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

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

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

Виджет в ЛК Calltouch

В кабинете необходимо настроить виджет клиентских форм
и задать настройки, обязательные для маршрутизации звонка:

• график работы колл-центра / номер переадресации
• сценарий дозвона (рекомендуем оставить по нажатию клавиши, если у КЦ настроен IVR)

Просьба обратить особое внимание настройки передачи ключа(поле routeKey) на первом табе виджета "Настройки".
Ключ является связкой между настройками виджета и формой, с которой приходят данные.
Данный параметр является обязательным при передаче тела запроса через API. Ключ может быть любым набором букв и символов.
Рекомендуем в поле ключа использовать “говорящее” название для удобства формирования тела запроса по API.
Например, ключ может быть равен названию ЖК/дилера/формы сайта.

Синтез речи

Вы так же можете передавать в теле заявки дополнительные текстовые параметры(поле fields), которые будут
выводиться в блок “Клиент” плеера Журнала звонков.
По этим же полям можно настроить синтез речи и передавать необходимую информацию для оператора.
Более подробно в здесь.

Группа методов API

Для ознакомлением с описанием метода /api/widget-request/user-form/create необходимо перейти по ссылке http://api.calltouch.ru/widget-service/v1/
Для просмотра документации перейдите в параметры заявки:

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

 

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

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

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

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

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

Список ошибок

Код	Описание
1	Синтаксическая ошибка JSON в запросе или запрос пустой
10001	Невозможно создать заявку виджета, недостаточно минут обратного звонка
10002	Невозможно создать заявку виджета, услуга обратного звонка не включена
10003	Невозможно создать заявку виджета, не найдено включенных виджетов с указанным ключём
10004	Невозможно создать заявку виджета, указанная сессия не найдена
10005	Превышен лимит отправки заявок в рамках сессии, если передан sessionId
10006	Превышен лимит отправки заявок на один и тот же номер телефона, если не передан sessionId
10007	Превышен лимит минимального интервала между отправкой заявок по номеру телефону или сессии

Статистика

Звонкам, совершенным в рамках заявки на обратный звонок, будет присвоен источник, который будет выводиться в отчетах, журнале звонков, api и будет передан в webhook'ах.
По умолчанию это значения:
- utm_source=Callback
- utm_medium=<не указано>
- utm_campaign=<не заполнено>
- utm_content=<не указано>
- utm_term=<не указано>

Можно переопределить источник при создании заявки двумя способами.
1. Указав значения явно в параметрах utmSource, utmMedium, utmCampaign, utmContent, utmTerm
2. Передав идентификатор сессии Calltouch в параметре sessionId, тогда источник будет взят из сессии. Идентификатор сессии должен принадлежать сайту, из-под токена которого выполняется запрос, иначе запрос вернет ошибку 10004.

Если указаны одновременно utmSource, utmMedium, utmCampaign, utmContent, utmTerm и sessionId, то sessionId имеет более высокий приоритет и источник будет взят из сессии.

Если в заявках не передается sessionId, все звонки будут БЕЗ ИСТОЧНИКА.