Добавление настроек пула и сценария переадресации для используемого статического номера

Читать 5

Описание

В статье описан API-метод добавления настроек пула и сценария переадресации для используемого статического номера. 

Если номер свободный (не закреплен ни за одним пулом), используйте API-метод добавления настроек пула и сценария переадресации для свободного статического номера.

Запрос

Чтобы получить список свободных номеров, необходимо выполнить API-метод получения информации о настройках пула и сценария переадресации по массиву номеров.

Если в ответе в объекте displayOptions значение null значит номер свободный.

POST: 

https://api.calltouch.ru/phone-service/v1/api/calltracking/ad-platform/phone/update

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

Да

Cтатический офлайн-номер Calltouch, максимум 1 номер.

Формат: 7xxxxxxxxxx

displayOptions

object

Нет

Условия отображения статического пула в отчетах, который закреплен за этим номером 

displayOptions.source
displayOptions.medium
displayOptions.campaign

string

Да, если указан displayOptions

Значения канала, источника и кампании, которые будут отображаться в отчетах

displayOptions.content
displayOptions.keyword

string

Нет

Значения объявления и ключевого слова, которые будут отображаться в отчетах

redirectOptions

object

Нет

Сценарий переадресации

redirectOptions.redirectType

object

Да, если указан redirectOptions

В API поддерживается пока что один тип сценария переадресации — на номер телефона. Передаваемое значение всегда равно PSTN

redirectOptions.ptsnOptions.redirectNumber

string

Да, если указан redirectOptions

Номер переадресации.

Формат: 7xxxxxxxxxx

reserveRedirect

object

Нет

Резервный сценарий переадресации на случай, если основной сценарий не отвечает

reserveRedirect.reserveNumber

string

Да, если указан reserveRedirect 

Номер резервной переадресации.

Формат: 7xxxxxxxxxx

reserveRedirect.reserveTimeOut

string

Да, если указан reserveRedirect

Время в секундах, через которое звонок с основного сценария будет переадресован на резервный номер

Возможные значения от 10 до 120 (сек)

reserveRedirect.ignoreEarlyMedia

string

Нет

Если опция включена, то при переадресации на резервный номер голосовые оповещения на основном сценарии (мелодии, гудки и т.п.) будут проигнорированы — это поможет корректно определить, что на основном сценарии не ответил реальный человек или он не доступен, и выполнить переадресацию на резервный номер.

 

Возможные значения:

  • true
  • false

Если параметр не передается, то устанавливается значение ignoreEarlyMedia по умолчанию = true.

poolName

string

Нет

Название пула

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

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

Система баллов API Calltouch

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

Количество запросов в секунду к API Calltouch ограничено — не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой c кодом 429 (Too Many Requests).

Не нашли решение проблемы?
Заполните форму, и мы вам поможем.
Похожие статьи
Недавно просмoтренные