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

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

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
phone_number	string		да	да	Виртуальный номер
category	enum	usual - обычные; bronze - бронзовые; silver - серебряные; gold - золотые.	да	да	Категория номера
location_mnemonic	enum		да	да	Мнемоника региона
location_name	string			да	Регион
onetime_payment	number				Стоимость подключения номера
monthly_charge	number				Ежемесячная абонентская плата
min_charge	number			да	Минимальный счёт, в месяц

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

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "get.available_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": [
      {
        "phone_number": "string",
        "category": "enum",
        "location_mnemonic": "enum",
        "location_name": "string",
        "onetime_payment": "number",
        "monthly_charge": "number",
        "min_charge":"number"
      }
    ]
  }
}

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

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