Получение информации о настройках пула и сценарии переадресации
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 номеров |
Ответ:
{ "data": [ [ { "phoneNumber": "string", "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 |
phoneNumber |
string |
Статический номер телефона Calltouch |
redirectStatus |
string |
Статус настройки сценария переадресации.
Если статус любой другой, значит сценарий пока не настроен или находится в процессе настройки.
|
redirectOptions |
object |
Сценарий переадресации |
redirectOptions.redirectType |
string |
Тип сценария переадресации.
Сложный сценарий переадресации
|
redirectOptions.ptsnOptions |
object |
Переадресация на номер телефона |
redirectOptions.ptsnOptions redirectNumber |
string |
Номер переадресации |
displayOptions
|
object |
Условия отображения |
displayOptions.source
displayOptions.content
|
string |
Значения канала, источника и кампании, объявления и ключевого слова, которые отображаются в отчетах |
poolName |
string |
Название пула |
Важно! Значения, которые есть в ответе, но нет в описании являются бета-параметрами, их не следует использовать для интеграции.