HTTP API - Get Configuration: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
No edit summary
Tag: 2017 source edit
No edit summary
Line 1: Line 1:
POST http:// gateway /api/get_config
'''POST http:// gateway /api/get_config'''


Request Parameter
'''Request Parameters:'''
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
Line 29: Line 29:
|Content is plastic, the  value is 0-31,  empty means all
|Content is plastic, the  value is 0-31,  empty means all
|}  
|}  
Response Parameter
'''Response Parameters:'''
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
|'''Parameter'''
|'''Type'''
|'''Type'''
| colspan="2" |'''Description'''
|'''Description'''
|-
|-
| colspan="4" |Returns the object in JSON format,  the following is the object  content, including at least one
| colspan="3" |Returns the object in JSON format,  the following is the object  content, including at least one
|-
|-
|sip_proxy
|sip_proxy
|Object
|Object
|"domain":"172.18.25.31"
|"domain":"172.18.25.31" Domain/IP
"port":5060 Port


"port":5060 "check_network_status":"on"
"check_network_status":"on" Keepalive Enable
|Domain/IP Port
 
Keepalive Enable
|-
|-
|sip_trunk
|sip_trunk
|Array,contain s at least one object
|Array,contain s at least one object
|"index":0 "enable":"on"
|"index":0 Index
"enable":"on" Status
 
"domain":"172.18.25.31" Domain/IP
 
"port":5060 Port


"domain":"172.18.25.31"
"description":"xxxx" Description
|Index Status Domain/IP
 
|-
"check_network_status":"on" Keepalive Enable
|
|
|"port":5060
|Port
|-
|
|
|"description":"xxxx"
|Description
|-
|
|
|"check_network_status":"on"
|Keepalive Enable
|-
|-
|ip_to_tel_routing
|ip_to_tel_routing
|Array,contain  s  at least one object
|Array,contains at least one object
|"index":0 "enable":"on"
|"index":0 index
"operation": "Allow"       Call restriction Allow/  Forbid "description":""                                            Description
"enable":"on" Status


"src_mode":"sip_trunk"                  Call Source
"operation": "Allow" Call restriction Allow/ Forbid


SIP Trunk/SIP Trunk Group/SIP Server
"description":"" Description


"src_id":0                   SIP Trunk/SIP Trunk  Group ID "dst_mode":"port_group"     Call delivery
"src_mode":"sip_trunk" Call Source


Port/Port Group  
SIP Trunk/SIP Trunk Group/SIP Server


"dst_id":0                            Port/Port Group ID
"src_id":0 SIP Trunk/SIP Trunk Group ID


"src_prefix":""                     Calling number prefix
"dst_mode":"port_group" Call delivery


"dst_prefix":""                     Called number prefix "prefix_to_be_added":""         Add prefix number
Port/Port Group


"suffix_to_be_added":""         Add suffix number "del_digit":0                                           Remove prefix  digits
"dst_id":0 Port/Port Group ID


"reserve_digit":255                Reserved number digits
"src_prefix":"" Calling number prefix
|index Status
 
"dst_prefix":"" Called number prefix
 
"prefix_to_be_added":"" Add prefix number
 
"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,contain  s  at least one object
|Array,contains at least one object
|"index":63                            index
|"index":63 index
"enable":"on"                        Status "description":"default"           Description
"enable":"on" Status
 
"description":"default" Description
 
"operation": "Allow" Call restriction Allow/ Forbid
 
"src_mode":"port_group" Call Source
 
Port/Port Group


"operation": "Allow"       Call restriction Allow/ Forbid
"dst_mode":"sip_trunk_group" Call delivery


"src_mode":"port_group"    Call Source
SIP Trunk/SIP Trunk Group/SIP Server


Port/Port Group  
"src_id":0 Port/Port Group ID


"dst_mode":"sip_trunk_group"    Call delivery
"dst_id":0 SIP Trunk/SIP Trunk Group ID


SIP Trunk/SIP Trunk Group/SIP Server
"src_prefix":"" Calling number prefix


"src_id":0   Port/Port  Group ID
"dst_prefix":"" Called number prefix


"dst_id":0   SIP Trunk/SIP Trunk Group ID "src_prefix":""  Calling number prefix "dst_prefix":""                  Called number prefix "prefix_to_be_added":""   Add prefix number "suffix_to_be_added":""    Add  suffix number "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                             Index,int
|"index":0 Index,int
"enable":"on"                        Status
"enable":"on" Status
 
"description":"all"                   Description
 
"sip_account":""                       SIP ID


"sip_authid":""                        SIP Auth ID
"description":"all" Description


"sip_authpswd":""                     Password "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


Trunk-index
"sip_authpswd":"" Password


"select_type":"cyclic_ascending"                                                  ascending/ cyclic_ascending/ descending/ cyclic_descending/ unknown
"port_map":"[ 0,1,2,3,4,5,6,7]" Port,Array


"tel_to_ip_hot_line":""    VOIP Hotline  "ip_to_tel_hot_line":""    PSTNHotline
"reg_type":"no_register" no_register/ sip_proxy/
|
|}  
|}  



Revision as of 22:22, 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 "domain":"172.18.25.31" Domain/IP

"port":5060 Port

"check_network_status":"on" Keepalive Enable

sip_trunk Array,contain s at least one object "index":0 Index

"enable":"on" Status

"domain":"172.18.25.31" Domain/IP

"port":5060 Port

"description":"xxxx" Description

"check_network_status":"on" Keepalive Enable

ip_to_tel_routing Array,contains at least one object "index":0 index

"enable":"on" Status

"operation": "Allow" Call restriction Allow/ Forbid

"description":"" Description

"src_mode":"sip_trunk" Call Source

SIP Trunk/SIP Trunk Group/SIP Server

"src_id":0 SIP Trunk/SIP Trunk Group ID

"dst_mode":"port_group" Call delivery

Port/Port Group

"dst_id":0 Port/Port Group ID

"src_prefix":"" Calling number prefix

"dst_prefix":"" Called number prefix

"prefix_to_be_added":"" Add prefix number

"suffix_to_be_added":"" Add suffix number

"del_digit":0 Remove prefix digits

"reserve_digit":255 Reserved number digits

tel_to_ip_routing Array,contains at least one object "index":63 index

"enable":"on" Status

"description":"default" Description

"operation": "Allow" Call restriction Allow/ Forbid

"src_mode":"port_group" Call Source

Port/Port Group

"dst_mode":"sip_trunk_group" Call delivery

SIP Trunk/SIP Trunk Group/SIP Server

"src_id":0 Port/Port Group ID

"dst_id":0 SIP Trunk/SIP Trunk Group ID

"src_prefix":"" Calling number prefix

"dst_prefix":"" Called number prefix

"prefix_to_be_added":"" Add prefix number

"suffix_to_be_added":"" Add suffix number

"del_digit":0 Remove prefix digits

"reserve_digit":0 Reserved number digits

port_group Array,contains at least one object "index":0 Index,int

"enable":"on" Status

"description":"all" Description

"sip_account":"" SIP ID

"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/

Example:

Request

curl -d '

{"sip_proxy":[],"sip_trunk":[ ],"ip_to_tel_routing":[ ],"port_gr

oup":[],"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":""}]}