Добавление настроек пула и сценария переадресации для свободного статического номера
Описание
POST: https://api.calltouch.ru/phone-service/v1/api/calltracking/ad-platform/phone/create
Headers:
- Access-Token — API-ключ
- SiteId — ID ЛК Calltouch
Данные параметры вы можете получить в личном кабинете Calltouch в разделе:
Интеграции /
Отправка данных во внешние системы / API и Webhooks.
Тело запроса в формате JSON:
{ "phoneNumber": "string", "displayOptions": { "source": "string", "medium": "string", "campaign": "string", "content": "string", "keyword": "string" }, "redirectOptions": { "redirectType": "PSTN", "ptsnOptions": { "redirectNumber": "string" }, "reserveRedirect": { "reserveNumber": "string", "reserveTimeOut": 0, "ignoreEarlyMedia": true } }, "poolName": "string" }
В случае успешного ответа отдается код 200, тело ответа при этом пустое.
Описание
Параметр |
Тип |
Обязательно |
Описание |
phoneNumber |
string |
Да |
Статический офлайн-номер Calltouch, максимум 1 номер. |
displayOptions |
object |
Да |
Условия отображения статического пула в отчетах, который закреплен за этим номером |
displayOptions.source |
string |
Да |
Значения канала, источника и кампании, которые будут отображаться в отчетах |
displayOptions.content |
string |
Нет |
Значения объявления и ключевого слова, которые будут отображаться в отчетах |
redirectOptions |
object |
Да |
Сценарий переадресации |
redirectOptions.redirectType |
object |
Да |
В API поддерживается пока что один тип сценария переадресации — на номер телефона. Передаваемое значение всегда равно PSTN |
redirectOptions.ptsnOptions.redirectNumber |
string |
Да |
Номер переадресации. Формат: 7xxxxxxxxxx |
reserveRedirect |
object |
Нет |
Резерный сценарий переадресации на случай, если основной сценарий не отвечает |
reserveRedirect.reserveNumber |
string |
Да, если указан reserveRedirect |
Номер резервной переадресации. Формат: 7xxxxxxxxxx |
reserveRedirect.reserveTimeOut |
string |
Да, если указан reserveRedirect |
Время в секундах, через которое звонок с основного сценария будет переадресован на резервный номер Возможные значения от 10 до 120 (сек) |
reserveRedirect.ignoreEarlyMedia |
string |
Нет |
Если опция включена, то при переадресации на резервный номер голосовые оповещения на основном сценарии (мелодии, гудки и т.п.) будут проигнорированы — это поможет корректно определить, что на основном сценарии не ответил реальный человек или он не доступен, и выполнить переадресацию на резервный номер.
Возможные значения:
Если параметр не передается, то устанавливается значение ignoreEarlyMedia по умолчанию = true. |
poolName |
string |
Да |
Название пула |
Данный метод необходимо использовать для свободных статических номеров, которые не закреплены за пулами.
Система баллов API Calltouch
Система баллов API — механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов. За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch
Количество запросов в секунду к API Calltouch ограничено — не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой c кодом 429 (Too Many Requests).
- A/B тестирование (раздел «Подключение»)
- Email-трекинг (раздел «Подключение»)
- Отслеживание офлайн конверсии (раздел «Подключение»)
- Подключение к отслеживанию дополнительных доменов (раздел «Подключение»)
- Подмена номеров на AMP-страницах Google (раздел «Подключение»)