Получение списка пулов

  1. HTTP-запрос
  2. Query-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
  4. Пример

Выгружает список пулов из Трекера по заданным параметрам. Также поддерживается метод POST. Чтобы получить список пулов в формате CSV, используйте эндпоинт /v2/pool/list/csv.

HTTP-запрос

GET /v2/pool/list\
?apiKey={string}\
&counter={string}\
&itemsPerPage={integer}\
&page={integer}

Query-параметры

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика, с которого будет сниматься статистика.

itemsPerPage

integer

Число результатов на странице.

page

integer

Порядковый номер страницы ответа.

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика, с которого будет сниматься статистика.

itemsPerPage

integer

Число результатов на странице.

page

integer

Порядковый номер страницы ответа.

Ответы

Код 200

Возвращает список пулов.

{
  "result": {},
  "totalResults": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

result

object

Статистика по пулам.

result.Id

integer

Идентификатор пула.

result.accuracy

integer

Точность, с которой определяется источник для звонков на номера из этого пула.

result.campaign

string

Ключевое слово по умолчанию.

result.content

string

Содержание объявления по умолчанию.

result.isActive

boolean

Признак активности пула. Если отключен, то не участвует в ротации номеров.

result.isClassic

boolean

Тип закрепления номера: true - закрепление за пользователем, false - закрепление за параметром.

result.label

string

Label по умолчанию.

result.medium

string

Тип трафика по умолчанию.

result.name

string

Название пула. Задается при создании и редактирвоании.

result.numbers

string

Номера в пуле.

result.numbersNeeded

integer

Сколько номеров не хватает для точности более 95%.

result.numbersTotal

string

Номеров в пуле.

result.priority

integer

Приоритет при ротации номеров. При ротации пулы сортируются по приоритету и далее проверяются по условиям подмены.

result.reservedSeconds

integer

Время резерва пула.

result.rotationRules

object

Правила подмены. Если пул подходит по условиям - номер берется из него.

result.rotationRules.condition

string

result.rotationRules.rules

object

result.rotationRules.rules.field

string

result.rotationRules.rules.id

string

result.rotationRules.rules.input

string

result.rotationRules.rules.operator

string

result.rotationRules.rules.value

string

result.source

string

Источник по умолчанию.

result.term

string

Ключевое слово по умолчанию.

totalResults

integer

Количество пулов в выдаче

result

object

Статистика по пулам.

result.Id

integer

Идентификатор пула.

result.accuracy

integer

Точность, с которой определяется источник для звонков на номера из этого пула.

result.campaign

string

Ключевое слово по умолчанию.

result.content

string

Содержание объявления по умолчанию.

result.isActive

boolean

Признак активности пула. Если отключен, то не участвует в ротации номеров.

result.isClassic

boolean

Тип закрепления номера: true - закрепление за пользователем, false - закрепление за параметром.

result.label

string

Label по умолчанию.

result.medium

string

Тип трафика по умолчанию.

result.name

string

Название пула. Задается при создании и редактирвоании.

result.numbers

string

Номера в пуле.

result.numbersNeeded

integer

Сколько номеров не хватает для точности более 95%.

result.numbersTotal

string

Номеров в пуле.

result.priority

integer

Приоритет при ротации номеров. При ротации пулы сортируются по приоритету и далее проверяются по условиям подмены.

result.reservedSeconds

integer

Время резерва пула.

result.rotationRules

object

Правила подмены. Если пул подходит по условиям - номер берется из него.

result.rotationRules.condition

string

result.rotationRules.rules

object

result.rotationRules.rules.field

string

result.rotationRules.rules.id

string

result.rotationRules.rules.input

string

result.rotationRules.rules.operator

string

result.rotationRules.rules.value

string

result.source

string

Источник по умолчанию.

result.term

string

Ключевое слово по умолчанию.

totalResults

integer

Количество пулов в выдаче

Пример

Responses:

{
  "totalResults": 1
}
Скопировано