Получение списка доступных префиксов телефонов регионов

Метод get.available_ct_phone_prefixes
Описание Получение списка доступных префиксов телефонов регионов с учетом свободных номеров КТ
Кому доступен Агент, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
fields array нет См. раздел "Представление возвращаемых данных"
Фильтры применяемые в отчете
filter object нет Допустимо использовать не более 2 уровней вложенности. Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации"
filters array да Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Критерии фильтрации" .
field string Поле сущности к которой будет применяться фильтрация (список заранее определен для метода)
operator enum Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации"
value string Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота.
Сортировка применяемая в отчете
sort array нет Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных"

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

Название Тип Допустимые значения Фильтрация Сортировка Описание
prefix enum да да Уникальный телефонный код региона
prefix_name enum да да Название региона

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

Копировать
{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.available_ct_phone_prefixes",
 "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": [
      {
       "prefixe": "enum",
       "prefix_name": "enum"
      }
    ]
  }
}

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

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

Спасибо за обращение
Понятно