Range
Function
This API is used to get Intercom > SIP Recipient 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/SIPRecipient/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 |
|---|---|---|---|
| recipients | 0-16 | array | 参见 Table 5 |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| name | 0-127 | string | Name |
| select | bool | Select | |
| domain | 0-127 | string | Domain |
| schedule_list | 0-8 | json array | defense planning table data,show as follow Table 6 |
Table 6
| Parameter | Range | Type | Description |
|---|---|---|---|
| enable | true, false | bool | Whether the current schedule takes effect |
| start_time | 0 – 1439(23*60+59) | int | Schedule start time (minutes relative to 00:00) |
| end_time | 0 – 1439(23*60+59) | int | Schedule end time (minutes relative to 00:00) |
| weekday | "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" | array | Indicates the day of a week when the current schedule takes effect. You can select multiple days |
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": {"recipients": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"name": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"select": {"type": "bool"},
"domain": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"schedule_list": {
"type": "array",
"min_size": 0,
"max_size": 8,
"items": {
"enable": {"type": "bool"},
"start_time": {
"type": "int32",
"min": 0,
"max": 1439
},
"end_time": {
"type": "int32",
"min": 0,
"max": 1440
},
"weekday": {
"type": "array",
"min_size": 1,
"max_size": 7,
"items": [{
"type": "string",
"items": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
}]
}
}
}
}
}}
}}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.