HTTP API - Get Configuration: Difference between revisions
No edit summary |
No edit summary |
||
(6 intermediate revisions by the same user not shown) | |||
Line 40: | Line 40: | ||
|Object | |Object | ||
| | | | ||
{| | {| | ||
|"domain":"172.18.25.31" | |"domain":"172.18.25.31" | ||
|Domain/IP | |Domain/IP | ||
Line 53: | Line 53: | ||
|sip_trunk | |sip_trunk | ||
|Array,contain s at least one object | |Array,contain s at least one object | ||
|"index":0 Index | | | ||
"enable":"on" Status | {| | ||
|"index":0 | |||
"domain":"172.18.25.31" Domain/IP | |Index | ||
|- | |||
"port":5060 Port | |"enable":"on" | ||
|Status | |||
"description":"xxxx" Description | |- | ||
|"domain":"172.18.25.31" | |||
"check_network_status":"on" Keepalive Enable | |Domain/IP | ||
|- | |||
|"port":5060 | |||
|Port | |||
|- | |||
|"description":"xxxx" | |||
|Description | |||
|- | |||
|"check_network_status":"on" | |||
|Keepalive Enable | |||
|} | |||
|- | |- | ||
|ip_to_tel_routing | |ip_to_tel_routing | ||
|Array,contains at least one object | |Array,contains at least one object | ||
|"index":0 index | | | ||
"enable":"on" Status | {| | ||
|"index":0 | |||
"operation": "Allow" Call restriction Allow/ Forbid | |index | ||
|- | |||
"description":"" Description | |"enable":"on" | ||
|Status | |||
"src_mode":"sip_trunk" Call Source | |- | ||
|"operation": "Allow" | |||
|Call restriction Allow/ Forbid | |||
|- | |||
|"description":"" | |||
|Description | |||
|- | |||
|"src_mode":"sip_trunk" | |||
|Call Source | |||
SIP Trunk/SIP Trunk Group/SIP Server | SIP Trunk/SIP Trunk Group/SIP Server | ||
|- | |||
"src_id":0 SIP Trunk/SIP Trunk Group ID | |"src_id":0 | ||
|SIP Trunk/SIP Trunk Group ID | |||
"dst_mode":"port_group" Call delivery | |- | ||
|"dst_mode":"port_group" | |||
Port/Port Group | |Call delivery Port/Port Group | ||
|- | |||
"dst_id":0 Port/Port Group ID | |"dst_id":0 | ||
|Port/Port Group ID | |||
"src_prefix":"" Calling number prefix | |- | ||
|"src_prefix":"" | |||
"dst_prefix":"" Called number prefix | |Calling number prefix | ||
|- | |||
"prefix_to_be_added":"" Add prefix number | |"dst_prefix":"" | ||
|Called number prefix | |||
"suffix_to_be_added":"" Add suffix number | |- | ||
|"prefix_to_be_added":"" | |||
"del_digit":0 Remove prefix digits | |Add prefix number | ||
|- | |||
"reserve_digit":255 Reserved number digits | |"suffix_to_be_added":"" | ||
|Add suffix number | |||
|- | |||
|"del_digit":0 | |||
|Remove prefix digits | |||
|- | |||
|"reserve_digit":255 | |||
|Reserved number digits | |||
|} | |||
|- | |- | ||
|tel_to_ip_routing | |tel_to_ip_routing | ||
|Array,contains at least one object | |Array,contains at least one object | ||
|"index":63 index | | | ||
"enable":"on" Status | {| | ||
|"index":63 | |||
"description":"default" Description | |index | ||
|- | |||
"operation": "Allow" Call restriction Allow/ Forbid | |"enable":"on" | ||
|Status | |||
"src_mode":"port_group" Call Source | |- | ||
|"description":"default" | |||
|Description | |||
|- | |||
|"operation": "Allow" | |||
|Call restriction Allow/ Forbid | |||
|- | |||
|"src_mode":"port_group" | |||
|Call Source | |||
Port/Port Group | Port/Port Group | ||
|- | |||
"dst_mode":"sip_trunk_group" Call delivery | |"dst_mode":"sip_trunk_group" | ||
|Call delivery | |||
SIP Trunk/SIP Trunk Group/SIP Server | SIP Trunk/SIP Trunk Group/SIP Server | ||
|- | |||
"src_id":0 Port/Port Group ID | |"src_id":0 | ||
|Port/Port Group ID | |||
"dst_id":0 SIP Trunk/SIP Trunk Group ID | |- | ||
|"dst_id":0 | |||
"src_prefix":"" Calling number prefix | |SIP Trunk/SIP Trunk Group ID | ||
|- | |||
"dst_prefix":"" Called number prefix | |"src_prefix":"" | ||
|Calling number prefix | |||
"prefix_to_be_added":"" Add prefix number | |- | ||
|"dst_prefix":"" | |||
"suffix_to_be_added":"" Add suffix number | |Called number prefix | ||
|- | |||
"del_digit":0 Remove prefix digits | |"prefix_to_be_added":"" | ||
|Add prefix number | |||
"reserve_digit":0 Reserved number digits | |- | ||
|"suffix_to_be_added":"" | |||
|Add suffix number | |||
|- | |||
|"del_digit":0 | |||
|Remove prefix digits | |||
|- | |||
|"reserve_digit":0 | |||
|Reserved number digits | |||
|} | |||
|- | |- | ||
|port_group | |port_group | ||
|Array,contains at least one object | |Array,contains at least one object | ||
|"index":0 | | | ||
"enable":"on" Status | {| | ||
|"index":0 | |||
"description":"all" Description | |Index, int | ||
|- | |||
"sip_account":"" SIP ID | |"enable":"on" | ||
|Status | |||
"sip_authid":"" SIP Auth ID | |- | ||
|"description":"all" | |||
"sip_authpswd":"" Password | |Description | ||
|- | |||
"port_map":"[ 0,1,2,3,4,5,6,7]" Port,Array | |"sip_account":"" | ||
|SIP ID | |||
"reg_type":"no_register" no_register/ sip_proxy/ | |- | ||
|"sip_authid":"" | |||
|SIP Auth ID | |||
|- | |||
|"sip_authpswd":"" | |||
|Password | |||
|- | |||
|"port_map":"[ 0,1,2,3,4,5,6,7]" | |||
|Port, Array | |||
|- | |||
|"reg_type":"no_register" | |||
|no_register/ sip_proxy/ | |||
|} | |||
|} | |} | ||
Latest revision as of 23:06, 7 May 2024
POST http:// gateway /api/get_config
Request Parameters:
Parameter | Type | Description |
The following are the parameters included in the object, select at least one | ||
sip_proxy | Array | Contents of the array can only be empty |
sip_trunk | Array | Content is plastic, the value is 0-31, empty means all |
ip_to_tel_routing | Array | Content is plastic, the value is 0-31, empty means all |
tel_to_ip_routing | Array | Content is plastic, the value is 0-31, empty means all |
port_group | Array | Content is plastic, the value is 0-31, empty means all |
Response Parameters:
Parameter | Type | Description | ||||||||||||||||||||||||||||
Returns the object in JSON format, the following is the object content, including at least one | ||||||||||||||||||||||||||||||
sip_proxy | Object |
| ||||||||||||||||||||||||||||
sip_trunk | Array,contain s at least one object |
| ||||||||||||||||||||||||||||
ip_to_tel_routing | Array,contains at least one object |
| ||||||||||||||||||||||||||||
tel_to_ip_routing | Array,contains at least one object |
| ||||||||||||||||||||||||||||
port_group | Array,contains at least one object |
|
Example:
Request
curl -d '{"sip_proxy":[],"sip_trunk":[ ],"ip_to_tel_routing":[ ],"port_group":[],"tel_to_ip_routing":[]}' -H "Content-Type: application/json" http://gateway_ip/api/get_config
Response
{ "sip_proxy":{"domain":"","port":5060,"check_network_status":"off"},"sip_trunk":[ {"index":31,"enable":"on","domain":"172.18.110.110","port":9367,"description":"cs","check_network_status":"off"}],"ip_to_tel_routing":[ {"index":63,"enable":"on","description":"default","ope ration":"Allow","src_mode":"sip_trunk","dst_mode":"port","src_id":31,"dst_id":0,"src_prefix ":"","dst_prefix":"","prefix_to_be_added":"","suffix_to_be_added":"","del_digit":0,"reserve_digit":0}],"tel_to_ip_routing":[ {"index":63,"enable":"on","description":"default","operation": "Allow","src_mode":"port_group","dst_mode":"sip_trunk_group","src_id":0,"dst_id":0,"src_ prefix":"","dst_prefix":"","prefix_to_be_added":"","suffix_to_be_added":"","del_digit":0,"reserve_digit":0}],"port_group":[ {"index":0,"enable":"on","description":"all","sip_account":"","sip_authid":"","sip_authpswd":"","port_map":"[ 0,1,2,3,4,5,6,7]","reg_type":"no_register","select_type":"cyclic_ascending","tel_to_ip_hot_line":"","ip_to_tel_hot_line":""}]}