Range
Function
This API is used to get Intercom > CallSetup parameter range.
Request Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel | "CH1"…"CHx" | string array | The channels supported by the device. |
Sample:
POST /API/Intercom/CallSetup/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response Message
Parameter Description
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel_info | object | Total channel information see Table 3. | |
| channel_max | int | The maximum number of channels. |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| CH1…CHx | object | See Table 4 |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| call_settings | object | Call Settings. See Table 5 | |
| sip_settings | object | SIP Settings. See Table 6 |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| ringtone | "Default" | string | Ringtone |
| calling_time_out | 10-180 | unsigned int | Calling Time Out |
| touchless_call | bool | Touchless Call | |
| status_led | "Automatic Mode","Stay On","Off" | string | Status LED: Automatic Mode, Stay On, Off |
Table 6
| Parameter | Range | Type | Description |
|---|---|---|---|
| enable_sip | bool | Enable SIP | |
| allow_incoming_sip_calls | bool | Allow Incoming SIP Calls | |
| voip_stream_settings | "Substream", "Mainstream", "Thirdstream" | string | VOIP Stream Settings |
| sip_port | 1-65535 | unsigned int | SIP Port |
| sip_tls_port | 1-65535 | unsigned int | SIP TLS Port |
| rtp_start_port | 1-65535 | unsigned int | RTP Start Port |
| ice | bool | ICE | |
| turn_enable | bool | TURN | |
| turn_server_address | 0-127 | string | TURN Server Address |
| user_name | 0-127 | string | User Name |
| password | 0-127 | string | Password |
| stun_enable | bool | STUN | |
| stun_server_address | 0-127 | string | STUN Server Address |
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": {
"call_settings": {
"type": "object",
"items": {
"ringtone": {
"type": "string",
"items": ["Default"]
},
"calling_time_out": {
"type": "uint32",
"mode": "r",
"min": 10,
"max": 180,
"default_value": 60
},
"touchless_call": {"type": "bool"},
"status_led": {
"type": "string",
"mode": "r",
"items": [
"Automatic Mode",
"Stay On",
"Off"
]
}
}
},
"sip_settings": {
"type": "object",
"items": {
"enable_sip": {"type": "bool"},
"allow_incoming_sip_calls": {"type": "bool"},
"voip_stream_settings": {
"type": "string",
"mode": "r",
"items": [
"Substream",
"Mainstream",
"Thirdstream"
]
},
"sip_port": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 65535,
"default_value": 5060
},
"sip_tls_port": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 65535,
"default_value": 5061
},
"rtp_start_port": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 65535,
"default_value": 4000
},
"ice": {"type": "bool"},
"turn_enable": {"type": "bool"},
"turn_server_address": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"user_name": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"password": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"stun_enable": {"type": "bool"},
"stun_server_address": {
"type": "string",
"min_len": 0,
"max_len": 127
}
}
}
}
}}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.