Для работы с 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"}
| Код | Описание |
|---|---|
| 1 | Синтаксическая ошибка JSON в запросе или запрос пустой |
| 2 | Передача данных по API отключена в настройках проекта |
| 3 | Сайт не активирован |
| 4 | Сайт не найден по указанному mod_id |
| 5 | Нет доступа к сайту |
| 6 | Некорректный идентификатор сайта |
| 10001 | Невозможно создать заявку, недостаточно минут обратного звонка |
| 10002 | Невозможно создать заявку, услуга обратного звонка не включена |
| 10003 | Невозможно создать заявку, не найдено включенных виджетов с указанным ключём |
| 10004 | Невозможно создать заявку, указанная сессия не найдена |
| 10005 | Превышен лимит отправки заявок в рамках сессии, если передан sessionId |
| 10006 | Превышен лимит отправки заявок на один и тот же номер телефона, если не передан sessionId |
| 10007 | Превышен лимит минимального интервала между отправкой заявок по номеру телефону или сессии |
| 10008 | Невозможно создать заявку, номер телефона находится в черном списке |
| 10009 | Невозможно создать заявку, номер телефона используется в пуле подменных номеров |
| 10010 | Невозможно создать заявку, указанный отдел не найден |
| 10011 | Получена заявка в нерабочее время с ключом %roteKey%, которая пришла с формы на странице сайта %siteUrl%. Для обработки таких заявок, необходимо включить сеттинг "Собирать заяви в нерабочее время" в табе "Настройки" виджета. |
| 10012 | Невозможно создать заявку, номер телефона не разрешен |
| 20001 | Звонок не найден |
| 20002 | Параметр logId не передан или имеет неправильный формат |
| 20003 | Не найден лог импорта звонка |
| 20004 | Поле callReferenceId должно быть уникально в рамках сайта |
| 20005 | Указано несуществующее пользовательское поле |
| 20006 | Указаное пользовательское поле должно иметь числовое значение |
| 30001 | Заявка не найдена |
| 30002 | Заявка с таким requestNumber уже существует |
| 30003 | Указано несуществующее пользовательское поле |
| 30004 | Указаное пользовательское поле должно иметь числовое значение |
| 40001 | Сделка не найдена |
| 40006 | Действие невозможно, т.к. найдено несколько сделок с одинаковым orderNumber. Чтобы выполнить операцию, выгрузите сделки с этим orderNumber, решите какую из них обновить, и отправьте запрос на обновление повторно, используя orderId (уникальный ID сделки внутри Calltouch), он будет присутствовать в выгрузки сделок. |
| 40007 | Неизвестная ошибка |
| 40012 | Нельзя удалить все статусы, должен остаться хотя бы один |
| 40013 | В списке находятся не существующие ID`s истории |
| 40015 | Процесса создания сделок по API с переданным logId не найдено. |
| 40016 | Указаны не все SiteIds, по которым ранее был произведен запрос на создание сделок. |
| 40017 | Параметр logId не передан или имеет неправильный формат. |
| 50001 | Указанный номер в личном кабинете Calltouch не найден |
| 50002 | Тип пула может иметь значение offline |
| 50003 | Вид пула может иметь значение static |
| 50004 | Не передан обязательный параметр displayOptions |
| 50005 | Номер уже используется в другом пуле |
| 50006 | Номер не прикреплен к пулу |
| 50007 | errors.api.redirect_type_is_not_available |
| 60001 | Не найдена задача импорта с указанным jobId |
| 70001 | Не найдены настройки cpa интеграции для переданных site_id и platform_name |
| 80001 | Лид с таким calltouchLeadId не найден в указанном ID сайта siteId |
| 80002 | Указано несуществующее пользовательское поле |
| 80003 | Указаное пользовательское поле должно иметь числовое значение |
| 90001 | Исчерпан часовой лимит баллов по сайту |
| 90002 | Исчерпан суточный лимит баллов по сайту |
| 100001 | Не найдено внешней метрики с таким названием, импорт невозможен. |
| 100002 | Указано некорректное значение идентификатора лога импорта |