General domain settings (settings)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
Getting the list of settings
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: key. |
|
|
Offset in the list of resources to output. |
|
|
Maximum number of resources in the list. |
|
|
Sorting order of resources in the list. |
|
|
Transformation of composite fields to flat form. |
Example request
GET /rest/v1/domain/settings?offset=0&limit=2 HTTP/1.1
Response
Field description: setting entity
Example response
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
}
}
]
Getting setting data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
Example request
GET /rest/v1/domain/settings/licowned HTTP/1.1
Response
Field description: setting entity
Example response
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
}
}
Modifying setting data
Fields prohibited for modification: key
Request
Field description: setting entity
Example request
PATCH /rest/v1/domain/settings/licowned HTTP/1.1
Content-Type: application/json; charset=utf-8
setting entity
Response
Field description: setting entity
Example response
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
}
}