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

Метод	get.virtual_numbers
Описание	Получение списка подключённых виртуальных номеров
Кому доступен	Агент, Клиент

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
id	number		да		Уникальный идентификатор виртуального номера
virtual_phone_number	string		да		Виртуальный номер
redirection_phone_number	string		да		Связанный номер Часто используется для 800 номеров
activation_date	iso8601	YYYY-MM-DD hh:mm:ss	да		Дата активации номера
status	enum	active waiting cleaning prereserved reserved manual_lock limit_lock	да	да	Статус номера
category	enum	usual bronze silver gold platinum	да	да	Категория номера
type	enum	va call_tracking dynamic_call_tracking	да	да	Тип номера
Рекламные кампании в которых используется виртуальный номер
campaigns	array		да		Список рекламных кампаний в которых используется виртуальный номер
campaign_id	number				Уникальный идентификатор рекламной кампании
campaign_name	string				Название рекламной кампании
site_id	number				Уникальный идентификатор сайта с которым связана рекламная кампания
site_domain_name	string				Адрес сайта в интернете с которым связана рекламная кампания. Без указания протокола - "http://" или "https://"
Блоки номеров рекламной кампании в которых используется номер
site_blocks	array				Список блоков номеров сайта, в которых используется виртуальный номер номер
site_block_id	number				Уникальный идентификатор блока номеров
site_block_name	string				Название блока номеров
Сценарии
scenarios	array		да		Список сценариев, которые связанны с виртуальным номером
scenario_id	number				Уникальный идентификатор сценария
scenario_name	string				Название сценария

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.virtual_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",
        "virtual_phone_number": "string",
        "redirection_phone_number": "string",
        "activation_date": "iso8601",
        "status": "enum",
        "category": "enum",
        "type": "enum",
        "campaigns": [
          {
            "campaign_id": "number",
            "site_id": "number",
            "site_domain_name": "string",
            "campaign_name": "string",
            "site_blocks": [
              {
                "site_block_id": "number",
                "site_block_name": "string",
                "is_tracking": "boolean"
              }
            ]
          }
        ],
        "scenarios": [
          {
            "scenario_id": "number",
            "scenario_name": "string"
          }
        ]
      }
    ]
  }
}

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

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