3.5.7 Externalring

Getting current settings

Get the current external ringing notification settings.

URL:

https://{{ip_addr}}/api/v1/hipmo/settings/externalring

HTTP method:

GET

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{
    "data": {
        "bypassDnd": false,
        "invertOutput": true,
        "isEnabled": false,
        "maxRingingTime": 30,
        "minRingingTime": 3,
        "usedOutput": 0
    }
}

Section setting

URL:

https://{{ip_addr}}/api/v1/hipmo/settings/externalring

HTTP method:

PUT

Response code:

Standard HTTP response code, treating syntactic errors.

Request body:
{
    "isEnabled": "<boolean>",
    "invertOutput": "<boolean>",
    "bypassDnd": "<boolean>",
    "usedOutput": "<integer>",
    "minRingingTime": "<integer>",
    "maxRingingTime": "<integer>"
}

Response data:

{
    "data": {
        "bypassDnd": false,
        "invertOutput": true,
        "isEnabled": false,
        "maxRingingTime": 30,
        "minRingingTime": 3,
        "usedOutput": 0
    }
}