Общие настройки домена (settings)

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/domain/settings

Получение списка настроек

GET

/rest/v1/domain/settings/<key>

Получение данных настройки

PATCH

/rest/v1/domain/settings/<key>

Изменение данных настройки


Получение списка настроек

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: key.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

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

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Пример запроса
GET /rest/v1/domain/settings?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: setting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "key": "alertcall_defaults",
    "value": {
      "attemptcount": 1,
      "attempttimeoutsec": 10,
      "callerid": "100",
      "callername": "AlertMachine",
      "calltimeout": 30,
      "trunkcount": 1
    }
  }
]

Получение данных настройки

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.

Пример запроса
GET /rest/v1/domain/settings/licowned HTTP/1.1

Ответ

Описание полей: setting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "key": "licowned",
  "value": {
    "devices": 100,
    "domains": 20,
    "ivrscripts": 10,
    "sipqueue": 0,
    "siptrunks": 200,
    "solution_era": 20,
    "svcscripts": 10,
    "userqueue": 0,
    "webservice_public": 5,
    "webservice_subscr": 1
  }
}

Изменение данных настройки

Поля запрещенные для изменения: key

Запрос

Описание полей: setting entity

Пример запроса
PATCH /rest/v1/domain/settings/licowned HTTP/1.1
Content-Type: application/json; charset=utf-8

setting entity

Ответ

Описание полей: setting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "key": "licowned",
  "value": {
    "devices": 120,
    "domains": 20,
    "ivrscripts": 10,
    "sipqueue": 0,
    "siptrunks": 200,
    "solution_era": 20,
    "svcscripts": 10,
    "userqueue": 0,
    "webservice_public": 5,
    "webservice_subscr": 1
  }
}