Получение информации по подменным номерам
Описание
С помощью данного API метода можно получать данные по всем номерам в проекте.
Запрос
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"
: [
"79000000000"
,
"79000000001"
],
"poolOptions": {
"poolIds"
: [
55555, 11111 ]
,
"poolType"
:
"onlineStatic"
,
"poolName"
: {
"value": "Остальные"
,
"filterMode": "contains"
}
},"displayOptions": {
"
: {source
""value": "yandex"
,
"filterMode": "exact"
},
"medium"
: {"value": "cpc"
},
"campaign"
: {"value": "msk",
"filterMode": "contains"
}
},"redirectOptions": {
"redirectIds"
: [2222, 3333]
,
"redirectStatus"
:"ACTIVE"
},
"phoneNumberStatus"
:
"ACTIVE"
,
"paymentStatus"
:
"PAIDED"
}
Параметры запроса
Параметр | Тип | Обязательно | Описание |
phoneNumbers | array | Нет |
Фильтр по номерам в Calltouch. При указании этого параметра будут выгружены только указанные номера (если они есть в проекте). Максимум можно указать 5000 номеров Формат: 7xxxxxxxxxx |
poolOptions | object | Нет | Объект с фильтрами по пулам. |
poolOptions.poolType | string | Нет |
Фильтр по типу пула.
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с указанным типом. Возможные значения:
Если не задан — по умолчанию all.
|
poolOptions.poolIds | array | Нет |
Фильтр по id пулов.
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с указанными id. Массив, можно указать несколько id пулов в массиве. Максимум 100 штук. |
poolOptions.poolName.value | string | Нет |
Фильтр по названию пула.
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими названиями. Поиск регистронезависимый. Может быть найдено несколько пулов с подходящим названием, тогда отдаем номера из всех подходящих пулов.
Максимум 100 символов.
|
poolOptions.poolName.filterMode | string | Нет |
Режим фильтрации по названию пула, описание режимов:
|
displayOptions | object | Нет | Объект с фильтрами по источникам. |
displayOptions.source.value | string | Нет |
Фильтр по настройкам отображения пула, параметр "Источник (utm_source)".
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими источниками в настройках отображения пула. Может быть найдено несколько подходящих пулов, тогда отдаем номера из всех подходящих пулов. Поиск регистронезависимый.
Максимум 100 символов.
|
displayOptions.source.filterMode | string | Нет |
Режим фильтрации, описание режимов:
|
displayOptions.medium.value | string | Нет |
Фильтр по настройкам отображения пула, параметр "Канал (utm_medium)".
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими источниками в настройках отображения пула. Может быть найдено несколько подходящих пулов, тогда отдаем номера из всех подходящих пулов. Поиск регистронезависимый.
Максимум 100 символов.
|
displayOptions.medium.filterMode | string | Нет |
Режим фильтрации, описание режимов:
|
displayOptions.campaign.value | string | Нет |
Фильтр по настройкам отображения пула, параметр "Кампания (utm_campaign)".
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими источниками в настройках отображения пула. Может быть найдено несколько подходящих пулов, тогда отдаем номера из всех подходящих пулов. Поиск регистронезависимый.
Максимум 100 символов.
|
displayOptions.campaign.filterMode | string | Нет |
Режим фильтрации, описание режимов:
|
displayOptions.content.value | string | Нет |
Фильтр по настройкам отображения пула, параметр "Объявление (utm_content)".
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими источниками в настройках отображения пула. Может быть найдено несколько подходящих пулов, тогда отдаем номера из всех подходящих пулов. Поиск регистронезависимый.
Максимум 100 символов.
|
displayOptions.content.filterMode | string | Нет |
Режим фильтрации, описание режимов:
|
displayOptions.term.value | string | Нет |
Фильтр по настройкам отображения пула, параметр "Ключевое слово (utm_term)".
При указании этого параметра будут выгружены только те номера, которые закреплены в пулах с подходящими источниками в настройках отображения пула. Может быть найдено несколько подходящих пулов, тогда отдаем номера из всех подходящих пулов. Поиск регистронезависимый.
Максимум 100 символов.
|
displayOptions.term.filterMode | string | Нет |
Режим фильтрации, описание режимов:
|
redirectOptions | object | Нет | Объект с фильтрами по настоенной на номерах переадресации. |
redirectOptions.redirectStatus | string | Нет |
Фильтр по статусу переадресации.
При указании этого параметра будут выгружены только номера с искомым статусом переадресации. Возможные значения:
|
redirectOptions.redirectIds | array | Нет |
Фильтр по id сценария переадресации.
При указании этого параметра будут выгружены только те номера, у которых настроена переадресации по сценариям с указанными id. Массив, можно указать несколько id сценариев переадресации в массиве. Максимум 50 штук. |
phoneNumberStatus | string | Нет |
Фильтр по статусу номера.
При указании этого параметра будут выгружены только номера с искомым статусом. Возможные значения:
|
paymentStatus | string | Нет |
Фильтр по статусу оплаты номера.
При указании этого параметра будут выгружены только номера с искомым статусом оплаты. Возможные значения:
|
Если в запросе не указать никаких входных параметров - то запрос вернет данные по всем номерам из статических оффлайн пулов и всем свободным номерам (не используемых в пулах), которые есть в проекте.
Ответ
Пример ответа
{ "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 |
Статус настройки сценария переадресации. Возможные значения:
Если статус любой другой, значит сценарий пока не настроен или находится в процессе настройки. |
data[n].redirectOptions | object | Сценарий переадресации |
data[n].redirectOptions .redirectType |
string |
Тип сценария переадресации. Возможные значения:
|
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 | Название пула |
data[n].poolType | string |
Тип пула, за которым закреплен номер. Возможные значения:
|
data[n].poolId | integer | id пула, за которым закреплен номер. Если номер не добавлен в пул — отдаем null. |
data[n].redirectOptions.redirectId | integer | id сценария переадресации, настроенного на номере. Если сценарий не настроен — отдаем null. |
Значения, которые есть в ответе, но нет в описании являются бета-параметрами, их не следует использовать для интеграции.
Система баллов 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 (раздел «Подключение»)