3.5.4 SIP

Getting current settings 

Get the current SIP Proxy server settings.

URL:

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

HTTP method:

GET

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{
    "data": {
        "ipAddress": "",
        "isEnabled": false,
        "name": "IndoorTouch",
        "password": "",
        "port": 5060,
        "protocol": 1,
        "registrar": {
            "expiry": 120,
            "ipAddress": "",
            "isEnabled": false,
            "port": 5060
        },
        "sipPortRandomization": false,
        "sipRandomPort": 5060,
        "userName": ""
    }
}

Section setting

URL:

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

HTTP method:

PUT

Response code:

Standard HTTP response code, treating syntactic errors.

Request body:
{
    "name": "<string>",
    "userName": "<string>",
    "password": "<string>",
    "ipAddress": "<string>",
    "port": "<integer>",
    "protocol": "<integer>",
    "isEnabled": "<boolean>",
    "sipPortRandomization": "<boolean>",
    "sipRandomPort": "<integer>",
    "registrar": {
        "ipAddress": "<string>",
        "isEnabled": "<boolean>",
        "expiry": "<integer>",
        "port": "<integer>"
    }
}

Response data:

{
    "data": {
        "ipAddress": "",
        "isEnabled": false,
        "name": "IndoorTouch",
        "password": "",
        "port": 5060,
        "protocol": 1,
        "registrar": {
            "expiry": 120,
            "ipAddress": "",
            "isEnabled": false,
            "port": 5060
        },
        "sipPortRandomization": false,
        "sipRandomPort": 5060,
        "userName": ""
    }
}