Получение информации о настройках пула и сценарии переадресации

Читать 3

Описание

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

Headers:

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

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

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

{
  "phoneNumbers": [
     "number1", "number2"
     ]
}

Описание:

Параметр

Тип

Обязательно

Описание

phoneNumbers

array

Нет

Статические оффлайн-номера Calltouch.
Максимум можно указать 5000 номеров
Формат: 7xxxxxxxxxx

Если не указать параметр phoneNumbers - то API метод вернет все статические оффлайн-номера, которые есть в проекте.


Ответ: 

{
    "data": [
        {
            "phoneNumber": "string",
            "datePhoneAddToPool": "yyyy-mm-dd hh:mm:ss"
            "phoneNumberStatus": "string",
            "paymentStatus": "string",
            "redirectStatus": "string",
            "redirectOptions": {   
                "redirectType": "PSTN",
                "ptsnOptions": {
                    "redirectNumber": "string"
                },
                "sipUriOptions": {
                    "forwardingSipUri": "string"
                },
                "sipTrunkOptions": {
                    "server": "string",
                    "login": "string",
                    "password": "string"
                },
                "reserveRedirect": {
                    "reserveNumber": "string",
                    "reserveTimeOut": 0,
                    "ignoreEarlyMedia": true
                }
            },
            "displayOptions": {
                "source": "string",
                "medium": "string",      
                "campaign": "string",
                "content": "string",
                "keyword": "string"
            },
            "poolName": "string"
        }
    ]
}

Описание:

Параметр

Тип

Описание

data

array

Массив данных по статическому номеру Calltouch

data[n].phoneNumber

string

Статический номер телефона Calltouch

data[n].datePhoneAddToPool

string

Дата и время добавления статического номера в пул. Формат yyyy-mm-dd hh:mm:ss. Если номер не добавлен в пул то null.

data[n].redirectStatus

string

Статус настройки сценария переадресации.
Возможные значения:

  • ACTIVE

Если статус любой другой, значит сценарий пока не настроен или находится в процессе настройки.

data[n].redirectOptions

object

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

data[n].redirectOptions
.redirectType

string

Тип сценария переадресации.
Возможные значения:

  • PSTN
Переадресация на номер

  • SIPURI
  • SIPTRUNK
  • custom

Сложный сценарий переадресации

data[n].redirectOptions
.ptsnOptions

object

Переадресация на номер телефона

data[n].redirectOptions
.ptsnOptions.redirectNumber

string

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

data[n].displayOptions

object

Условия отображения

data[n].displayOptions.source
data[n].displayOptions.medium
data[n].displayOptions.campaign
data[n].displayOptions.content
data[n].displayOptions.keyword

string

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

data[n].poolName

string

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

Значения, которые есть в ответе, но нет в описании являются бета-параметрами, их не следует использовать для интеграции.

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

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

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

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