Range

Function

This API is used to get Intercom > SIP Account parameter range.

Request Message

Parameter Description

Table 1
ParameterRangeTypeDescription
channel"CH1"…"CHx"string arrayThe channels supported by the device.

Sample:

POST /API/Intercom/SIPAccount/Range HTTP/1.1
{
    "version": "1.0",
    "data": {}
}

Response Message

Parameter Description

Table 2
ParameterRangeTypeDescription
channel_infoobjectTotal channel information see Table 3.
channel_maxintThe maximum number of channels.
Table 3
ParameterRangeTypeDescription
CH1…CHxobjectSee Table 4
Table 4
ParameterRangeTypeDescription
account_listobject参见 Table 5
Table 5
ParameterRangeTypeDescription
activeboolActive
settingsboolSettings
name0-127stringName
user_id0-127stringUser ID
domain0-127stringDomain
authentication_id0-127stringAuthentication ID
caller_id0-127stringCaller ID
transport_mode"UDP",TCP","TLS"stringTransport mode
status"Unavailable","Available"stringStatus
password0-127stringPassword
password_emptyboolIs the password empty

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "channel_max": 1,
        "channel_info": {
            "type": "object",
            "items": {"CH1": {
                "type": "object",
                "items": {"account_list": {
                    "type": "array",
                    "min_size": 0,
                    "max_size": 8,
                    "items": {
                        "active": {"type": "bool"},
                        "settings": {"type": "bool"},
                        "name": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "user_id": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "domain": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "password": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "password_empty": {"type": "bool"},
                        "authentication_id": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "caller_id": {
                            "type": "string",
                            "min_len": 0,
                            "max_len": 127
                        },
                        "transport_mode": {
                            "type": "string",
                            "items": [
                                "UDP",
                                "TCP",
                                "TLS"
                            ]
                        },
                        "status": {
                            "type": "string",
                            "mode": "r",
                            "items": [
                                "Unavailable",
                                "Available"
                            ]
                        }
                    }
                }}
            }}
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.