Skip to content

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

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

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

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

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

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

Название Тип Обязательный Описание
id number да Уникальный идентификатор тарифного плана
name string да Название тарифного плана

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

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

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

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

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

    },
    "data":[
      {
        "id":"number",
        "name":"string"
      }
    ]
  }
}

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

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