Skip to content

Получение списка виртуальных номеров доступных для настройки рекламной кампании

Получение списка виртуальных номеров доступных для настройки рекламной кампании

Метод get.campaign_available_phone_numbers
Описание Получение списка всех виртуальных номеров доступных для настройки параметра phone_number_id при создании/обновлении рекламной кампании
Кому доступен Агент, Клиент

Параметры запроса

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"

Параметры ответа

Название Тип Допустимые значения Фильтрация Сортировка Описание
id number да Уникальный идентификатор виртуального номера. Этот идентификатор должен использоваться в параметре phone_number_id метода create.campaign или update.campaign
phone_number string да Виртуальный номер
type enum
  • va
  • call_tracking
  • user
да Тип виртуального номера
  • va - номер ВАТС
  • call_tracking - номер Аналитики
  • user - пользовательский номер

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.campaign_available_phone_numbers",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {

    },
    "data": [
      {
        "id": "number",
        "phone_number": "string",
        "type": "enum"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"