Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

Данный ресурс позволяет получит получить информацию о различных лимитах клиента.

Table of Contents

Oписание структур данных

Expand
titleРазвернуть

Имя

Тип

Описание

application_limit

long

Максимальное количество приложений

calls_limit

long

Максимальное количество одновременных вызовов

dial_rule_limit

long

Максимальное количество правил набора

disk_quota

long

Размер дисковой квоты в байтах

event_limit

long

Максимальное количество обработчиков событий (одного внутреннего номера или агента очереди)

extension_agent_limit

long

Максимальное количество агентов очереди на один внутренний номер

extension_group_limit

long

Максимальное количество групп внутренних номеров

extension_limit

long

Максимальное количество внутренних номеров

incom_rule_limit

long

Максимальное количество правил входящего вызова

interval_limit

long

Максимальное количество временных интервалов

ivr_context_limit

long

Максимальное количество контекстов в одном внутреннем номере типа IVR

ivr_option_limit

long

Максимальное количество опций одного контекста IVR

ivr_rule_limit

long

Максимальное количество правил в одной опции контекста IVR

network_permission_limit

long

Максимальное количество доверенных сетей

reg_limit

long

Максимальное количество SIP-регистраций одного внутреннего номера. Значение 0 означает, что возможна одна регистрация и каждая следующая регистрация будет отменять предыдущую.
Значения 1 и больше означают, что при достижении указанного количества регистраций последующие регистрации будут невозможны

remote_agent_limit

long

Максимальное количество внешних агентов очередей

sound_limit

long

Максимальное количество звуков

user_client_limit

long

Максимальное количество пользователей типа "клиент

user_extension_group_limit

long

Максимальное количество пользователей типа "группа внутренних номеров"

user_extension_limit

long

Максимальное количество пользователей типа "внутренний номер" 

client_extension_application_limit

long

Максимальное количество приложений у пользователя уровня "внутренний номер" 

Пример

Получим лимиты текущего авторизованного клиента.

Tabs
[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication","marks":[{"type":"strong"}]},{"type":"text","text":" в поля "},{"type":"text","text":"client_id","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":"  требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/"},{"type":"text","text":"client/@me/limit/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[]}]}]}]}]},"id":"df10480f-99e6-494e-a584-ec1715ad6d91","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X GET ${url}/client/@me/limit/"}]}]},"id":"22d46a8f-304a-4380-b412-c27c37adb65d","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f\"{URL}/client/@me/limit/\"\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)"}]}]},"id":"c172142c-3fa8-482f-9c78-9b5d8bbce0b7","label":"На языке Python3","type":"tab"}]

Ответ системы:

Code Block
languagejson
{
  "disk_quota": 10485760,
  "application_limit": 10,
  "ivr_rule_limit": 2000,
  "user_extension_group_limit": 100,
  "extension_agent_limit": 100,
  "sound_limit": 30,
  "ivr_option_limit": 100,
  "user_client_limit": 100,
  "extension_group_limit": 5,
  "user_extension_limit": 100,
  "network_permission_limit": 20,
  "calls_limit": 50,
  "remote_agent_limit": 500,
  "event_limit": 25,
  "extension_limit": 5,
  "dial_rule_limit": null,
  "incom_rule_limit": 500,
  "ivr_context_limit": 100,
  "reg_limit": 0,
  "interval_limit": 500,
  "client_extension_application_limit": 1
}

Ресурcы раздела "Клиент"

Expand
titleGET /client/{client_id}/limit/

GET /client/{client_id}/limit/

Получить лимиты клиента

Параметры URL

Имя

Тип

client_id

string

Поля ответа

Имя

Тип

application_limit

long

calls_limit

long

dial_rule_limit

long

disk_quota

long

event_limit

long

extension_agent_limit

long

extension_group_limit

long

extension_limit

long

incom_rule_limit

long

interval_limit

long

ivr_context_limit

long

ivr_option_limit

long

ivr_rule_limit

long

network_permission_limit

long

phone_webrtc_limit

long

reg_limit

long

remote_agent_limit

long

sound_limit

long

user_client_limit

long

user_extension_group_limit

long

user_extension_limit

long