CONTROLLER-WEB-API Description
CONTROLLER-WEB-API Description
1 Public
1.1 Basic Interface Definitions
- The client must send the JSON of the restful api as POST
- The server returns json data in a fixed format.
1.2 API public encapsulation
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
token | string | – | Authentication, some whitelisting procedures ignored |
[ANY] | [ANY] | [ANY] | Other parameters are defined by the API function |
Server→Client Response
KEY | VAL | Default | Remark |
---|---|---|---|
uri | string | – | Returns the name of the URI corresponding to the request |
code | int | – | Success or failure identifier (refer to internationalisation.md) |
msg | string | – | Information Alerts |
data | array | – | Data content, defined by API functions |
Caveats:
- The project’s APIs are encapsulated in the /appenv/lib/icvpapi file. Please check the code to confirm the specific API function and implementation.
- Please refer to the public encapsulation first, the following interface description has been reduced in order to focus on the interface and therefore the description is reduced in content.
- At the time of the client request the data only describes the proprietary key part (the public part is not described, see as above)
- In Server return data only the content of data_subkey is described (the public part is not described, please refer to as above)
- Try to use string as a datatype and avoid using int on new development interfaces. nor any other datatype.
1.3 Description of DEF and REQ
REQ (for KEY instructions)
- Y indicates that it must be passed
- Y/N indicates that there are conditions that must be passed on, refer to the instructions to understand the conditions
- N indicates an optional parameter, which will be automatically ignored if not passed.
DEF (value-specific description)
- -: Indicates that an error will be reported directly when the value is illegal or incorrect.
- Empty: indicates that the empty string is automatically used to correct the value when it is not legal or wrong (note that it is not null)
- Other: if the value is not legal, it is automatically corrected using this value
Caveats:
- Mutual Exclusivity: When a mark has a statement that it is mutually exclusive with another key, the Default value is automatically used once the problem is detected.
- Other: Default value is used automatically when other issues arise
2. Authentication management category
2.1 WEB Login Control
2.1.1 Login /auth/login
Note: Login is a whitelisting function that allows access without authentication information.
Note: No token is required to access this interface
Note: To prevent hacker login DDOS attack, processing request random delay 0-2s
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
username | string | – | Account number Format: 4-32 characters |
password | string | – | Password (MD5 value) Format: 4-32 characters |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
level | string | – | Account Level Information | 230424 |
token | string | – | Current account token, valid for 600 seconds | 231201 |
2.1.2 Logging out /auth/logout
Client→Server Request
Server→Client Response
2.1.3 Log in to /auth/check_auth
Note: Check the permissions, the interface REST API is automatically called, no need to call the
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
ip | string | – | current IP address | 230415 |
token | string | – | Current account token, valid for 600 seconds | 231201 |
Server→Client Response
3 Network Function Class
3.1 Network interfaces
Note: There may be parts of this category of interface settings that have been implemented that need to take effect (/general/apply_do).
3.1.1 WAN network configuration /net_wan/set
Note: This interface needs to be in effect after setting up.
Note: When performing macaddr cloning, please set isclonemac to 1, otherwise the setting will not be successful. After exporting the configuration of the successfully cloned macaddr, the macaddr will be set when restoring the configuration.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
ip6enable | string | N | 0 | Enable ipv6 Format: 1 yes, 0 no (default) | 240326 |
proto | string | Y | – | Format: dhcp, static, pppoe | 240123 |
ipaddr | string | N/Y | – | static=REQ_Y IP address ip6enable=0 Format: IPv4 address, length 1-15; ip6enable=1 Format: IPv6 address, length 2-39 | 240123 |
netmask | string | N/Y | – | static=REQ_Y Subnet mask Format: IPv4 address, length 1-15 | 240123 |
gateway | string | N/Y | – | static=REQ_Y gateway ip6enable=0 Format: IPv4 address, length 1-15; ip6enable=1 Format: IPv6 address, length 2-39 | 240123 |
username | string | N/Y | – | pppoe=REQ_Y Account number Format: length 1-64 | 240123 |
password | string | N/Y | – | pppoe=REQ_Y Password format: length 1-64 | 240123 |
ac | string | N | Empty | pppoe=REQ_Y Access Concentrator Format: length 0-64 | 240123 |
service | string | N | Empty | pppoe=REQ_Y Service provider name Format: length 0-64 | 240123 |
peerdns | string | N | 1 | Remote DNS allowed Format: 1 allowed (default), 0 not allowed | 240123 |
dns | string | N | Empty | Fixed DNS, multi-DNS space-separated Format: length 0-64 ip6enable=0 Single dns format: IPv4 address, length 1-15; ip6enable=1 Single dns format: IPv6 address, length 2-39 | 240123 |
macaddr | string | N | Empty | MAC address cloning Format: MAC address, length 0 (not set)/17 (new MAC) | 240123 |
isclonemac | string | N | 0 | Enable MAC address cloning Format: 1 yes, 0 no (default) | 240123 |
management_access | string | N | 1 | Management access restrictions Format: 1 WAN and MGT (default), 0 MGT | 240123 |
vendorid | string | N | Empty | Set the vendorid that OPT 60 sends to the server Format: length 0-64 | 240123 |
ip6subnetprefixlength | string | N/Y | Empty | ip6enable=REQ_Y IPv6 subnet prefix length Range 0-128 | 240326 |
Server→Client Response
3.1.2 WAN network get /net_wan/get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
Reference /net_wan/set | ||||
assign_ipaddr | string | Dynamic data, current IP address | ||
assign_netmask | string | Dynamic data, current subnet mask | ||
assign_gateway | string | Dynamic data, current gateway | ||
assign_dns | string | Dynamic data, current DNS | ||
dhcp_expire_time | string | Dynamic data, current dhcp failure time (seconds) | ||
assign_ip6subnetprefixlength | string | Dynamic data, current IP6 subnet prefix length | 240326 |
3.1.3 LAN network configuration /net_lan/set
- Note: devices with platform as netbus should not support this interface, remember!!!!
- Note: This interface needs to be in effect after setting up.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
ipaddr | string | Y | – | IP address Format: IPv4 address | 240418 |
netmask | string | Y | – | Subnet mask Format: IPv4 address | 240418 |
Server→Client Response
3.1.4 LAN network get /net_lan/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
Reference /net_lan/set | 240418 |
3.1.5 MGT network configuration /net_mgt/set
Note: This interface needs to be in effect after setting up.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
disabled | string | Y | – | mgt port disabled Format: 0 no, 1 yes | 240319 |
proto | string | Y | – | Network protocol type Format: dhcp, static | 240319 |
ipaddr | string | N/Y | – | static=REQ_Y, IP address Format: IPv4 address, length 1-15; wan port ip6enable=1 Format: IPv6 address, length 2-39 | 240614 |
netmask | string | N/Y | – | static=REQ_Y, subnet mask Format: IPv4 address, length 1-15; wan port ip6enable=1, not valid | 240319 |
gateway | string | N | – | Gateway Format: IPv4 address, length 0-15; wan port ip6enable=1 Format: IPv6 address, length 0-39 | 240614 |
peerdns | string | N | 1 | Remote DNS allowed Format: 1 allowed, 0 not allowed | 240319 |
dns | string | N | unoccupied | Fixed DNS address, multiple DNS separated by spaces Format: length 0-64 | 240319 |
ip6subnetprefixlength | string | N/Y | unoccupied | wan port ip6enable=REQ_Y IPv6 subnet prefix length Range 0-128 | 240614 |
Server→Client Response
3.1.6 MGT network get /net_mgt/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
Reference /net_mgt/set | 240319 | ||||
assign_ipaddr | string | Dynamic data, current IP address | 240319 | ||
assign_netmask | string | Dynamic data, current subnet mask | 240319 | ||
assign_gateway | string | Dynamic data, current gateway | 240319 | ||
assign_dns | string | Dynamic data, current DNS | 240319 | ||
dhcp_expire_time | string | Dynamic data, current dhcp failure time (seconds) | 240319 |
3.1.7 VLAN PRIORITY configuration /net_vlan/set
Note: This interface needs to be in effect after setting up.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
wan_vlanid | int | N | 0 | Layer 2 QoS 802.1Q/VLAN tagging on WAN port, format: 0, 3-4094, 1,2 for internal system use | 240417 |
wan_signaling_priority | int | N | 0 | Layer 2 SIP signalling QoS 802.1p priority, format: 0-7 | 240417 |
wan_media_priority | int | N | 0 | Layer 2 voice QoS 802.1p priority, format: 0-7 | 240417 |
mgt_vlanid | int | N | 0 | Layer 2 QoS 802.1Q/VLAN tagging for mgt port, format: 0, 3-4094, 1,2 for internal system use | 240417 |
mgt_priority | int | N | 0 | Layer 2 QoS 802.1p priority, format: 0-7 | 240417 |
Server→Client Response
3.1.8 VLAN PRIORITY configuration get /net_vlan/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_vlan/set | 240417 |
3.2 Network routing
Note: route means route and router means router function are not one and the same.
3.2.1 Static Route Configuration /net_route/set
Note: This interface needs to be in effect after setting up.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
routes | array | N | – | Format [{ROUTEKV}…]. , refer to “ROUTEKV”. | 240423 |
ROUTEKV | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
interface | string | N | wan | Interface interface (basic, logical) Format: wan lan vpn1 | 240423 |
target | string | Y | – | Destination IP address Format: IPv4 address | 240423 |
netmask | string | Y | – | Subnet Mask Format: Subnet Mask (IPv4 Address) | 240423 |
gateway | string | N | unoccupied | Via gateway Format: IP address, empty | 240423 |
metric | int | N | 0 | Number of Leap Points Format: 0-1024 | 240423 |
Server→Client Response
3.2.2 Static route acquisition /net_route/get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_route/set | 240423 |
3.3 Service functions
3.3.1 DHCP service configuration /net_dhcp/set
- Note: Devices with platform as netbus should not support this interface call, remember!
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
start | int | N | 100 | Starting IP address Format: 1-500 | 240412 |
limit | int | N | 150 | Maximum number of allocations Format: 1-500 | 240412 |
leasetime | string | N | 12h | Rental time Format: (1-1000)h | 240412 |
ignore | int | N | 0 | Disabling services for LAN Format: 0 (not disabled) 1 (disabled) | 240412 |
Server→Client Response
3.3.2 DHCP Service Get /net_dhcp/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_dhcp/set | 240412 |
3.3.3 Setting the domain name resolution list /net_dhcp/dns_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
lists | array | N | – | Format [{RULESKV}…]. , refer to “RULESKV”. | 240412 |
RULESKV | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
domain | string | Y | – | Domain name Format: 1-63 characters | 240412 |
parse_ip | string | Y | – | Parse IP Format: IPv4 address | 240412 |
Server→Client Response
3.3.4 Getting the domain name resolution list /net_dhcp/dns_get
Client→Server Request
Server→Client Response
RULESKV | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_dhcp/dns_set | 240412 |
3.4 Firewalls
3.4.1 Basic Settings /net_firewall/set (incomplete)
3.4.2 Basic get /net_firewall/get (incomplete)
3.4.3 Transmission Rule Setting /net_firewall/rule_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
rules | array | N | – | Format [{RULESKV}…]. , refer to “RULESKV”. | 240422 |
RULESKV | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
name | string | N | unoccupied | Name Format: 0-32 characters | 240422 |
proto | string | N | tcp | Protocol Format: tcp udp icmp igmp all | 240422 |
src | string | N | unoccupied | Source network domain Format: wan lan mgt empty (not specified) | 240422 |
src_ip | string | N | unoccupied | Source IP or source network Format: IP address or IP/CIDR, nullable, length 0-32 | 240422 |
src_port | string | N | unoccupied | Source port Format: Single port 1-65536 Multiple ports (1-65536):(1-65536) | 240422 |
dest | string | N | unoccupied | Target network domain Format: wan lan mgt empty (not specified) | 240422 |
dest_ip | string | N | unoccupied | Destination IP or destination network Format: IP address or IP/CIDR, nullable, length 0-32 | 240422 |
dest_port | string | N | unoccupied | Destination port Format: single port 1-65536 Multiple ports (1-65536):(1-65536) | 240422 |
target | string | N | ACCEPT | Rule Action Format: ACCEPT REJECT DROP | 240422 |
enabled | int | N | 1 | Switch Format: 0 (off), 1 (on) | 240422 |
Server→Client Response
3.4.4 Transport Rule Get /net_firewall/rule_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_firewall/rule_set | 240422 |
3.4.5 Port forwarding settings /net_firewall/redirect_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
redirects | array | N | – | Format [{RDRTSKV}…]. , refer to “RDRTSKV”. | 240422 |
RDRTSKV | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
name | string | N | unoccupied | Name Format: 0-32 characters | 240422 |
proto | string | N | tcp | Protocol Format (optional): tcp udp icmp | 240422 |
src | string | N | wan | Source network domain Format: wan lan | 240422 |
src_dport | string | Y | – | Source Destination Port Format: single port 1-65536 multiple ports (1-65536):(1-65536), this value is null when proto is icmp, page label hidden | 240422 |
dest | string | N | lan | Target network domain Format: wan lan | 240422 |
dest_ip | string | Y | – | Destination IP Format: IP address | 240422 |
dest_port | string | Y | – | Destination port Format: single port 1-65536 multiple ports (1-65536):(1-65536), this value is null when proto is icmp, page label hidden | 240422 |
target | string | N | dnat | Forwarding model Format: dnat | 240422 |
Server→Client Response
3.4.6 Port Forwarding Get /net_firewall/redirect_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_firewall/redirect_set | 240422 |
3.5 Network Port IP Alias
3.5.1 IP Alias Configuration /net_alias/set
- Note: When the IP alias is set to null, it means that the alias is disabled.
- Note: This interface needs to be in effect after setting up.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
alias1_device | string | N | unoccupied | Binding interface (basic) Format: wan, lan, empty | 240412 |
alias1_ipaddr | string | N | unoccupied | IP address Format: IP format, 0-15 characters, null | 240412 |
alias1_netmask | string | N | unoccupied | Subnet mask Format: 0-15 characters, null | 240412 |
alias2_device | string | N | unoccupied | Binding interface (basic) Format: wan, lan, empty | 240412 |
alias2_ipaddr | string | N | unoccupied | IP address Format: IP format, 0-15 characters, null | 240412 |
alias2_netmask | string | N | unoccupied | Subnet mask Format: 0-15 characters, null | 240412 |
Server→Client Response
3.5.2 IP Alias Get /net_alias/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /net_alias/set | 240412 |
3.6 VPN Client
3.6.1 VPN Configuration /net_vpn/set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
switch | string | N | unoccupied | VPN enable type Format: openvpn empty (off) | 240425 |
ovpn_username | string | N | unoccupied | Account verification name Format: 0-32 characters, empty | 240425 |
ovpn_password | string | N | unoccupied | Account verification password Format: 0-32 characters, empty | 240425 |
ovpn_cert_password | string | N | unoccupied | cert authentication password Format: 0-32 characters, empty | 240425 |
ovpn_config | string | N | unoccupied | ovpn configuration contents Format: 0-32678 characters, empty | 240425 |
Server→Client Response
3.6.2 VPN Get /net_vpn/get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
ovpn_status | string | 0 | VPN connection status Format: 0 (not connected), 1 (connected) | 240425 | |
ovpn_ipaddr | string | unoccupied | IP address after successful VPN connection | 240425 | |
ovpn_netmask | string | unoccupied | Mask after successful VPN connection | 240425 | |
References /net_vpn/set |
3.6.2 VPN log /net_vpn/log
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
limit | int | N | 128 | Number of log lines Format: 1-1024 | 240425 |
Server→Client Response
DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
log | string | 240425 |
3.7 Network model
3.7.1 Network mode switching /net_switch/set
Note: This interface needs to be set up with a requirement for it to take effect (/general/apply_do).
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
network_mode | string | Y | – | Network Mode Format Optional value to be obtained via configuration, example: route/bridge | 240123 |
Server→Client Response
3.7.2 Network mode get /net_switch/get
Note: If type_list has only one value, it means that the device is a single port, or the device is a dual port but not switchable.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
type_list | array | – | Switching mode selectable list Format: [bridge,route], contains list values for bridge and route. | 230925 |
References /net_switch/set | 230901 |
4 System Function Classes
4.1 Information output
4.1.1 Product information /sys_info/oem
This interface is used for the front-end to know the current system constraints and WEB display vendor information, it is recommended to read it once after login and save it continuously.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
platform | string | netbus (multi-CPU architecture), combined (single-CPU architecture) | 230209 | |
firmware_model | string | Firmware Model | ||
firmware_version | string | Firmware version | ||
vendor | string | Publisher’s name (for display only) | ||
website | string | Publisher’s website (display only) | ||
product | string | Product name (for display only) | ||
region | string | Country or area 2-digit code (unknown function) | ||
language | string | Default language 2-digit code (display only) | ||
model2 | string | Model number (for display only) | ||
sn | string | Serial number information | 230608 | |
maxslots | int | Maximum number of slots (numbered from 0), combined thinks there is only slot 0, so maxslots is 1 | 230209 | |
interface | string | Physical interface type: analogue, digital | 230209 | |
maxspans | int | Maximum number of SPANs per slot (numbering starts at 1, analogue is always 1) | 230209 | |
maxchannels | int | Maximum number of channels per SPAN (numbered from 1) | 230209 | |
maxprofiles | int | Maximum number of allowed policies (numbered from 0) | ||
fxs_enable | string | Whether the device has fxs, value is yes or no | 230613 | |
fxo_enable | string | Whether the device has fxo, value is yes or no | 230613 | |
maxacls | int | Maximum number of ACL whitelist lists | ||
maxlocalswitchlist | int | Maximum number of rules for self-swap | ||
maxdigitmaprule | int | Maximum number of rules per digraph strategy | ||
maxcallrouterule | int | Maximum number of call routing rules | 230309 | |
maxroutelist | int | Maximum number of static routing rules | 220902 | |
maxfirewallrules | int | Maximum number of firewall rules | 220906 | |
fxo_groupstart | int | FXO grouping start numbering | 221208 | |
fxo_groupmax | int | Total number of FXO groups | 221208 | |
mac_str | string | Primary mac address | 230228 | |
extraface | string | Extended interface parameters. Digital trunking for bri or t1e1 | 230303 | |
maxsiptrunk | int | Maximum number of trunks (valid only if interface is digital) (numbering starts from 0) | 230309 | |
product_id | string | Motherboard Hardware Version | 230815 | |
vendor_cn | string | Publisher Chinese | 231121 | |
style | string | Menu Style Style | 231121 |
4.1.2 System status /sys_info/performance
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
uptime | int | System run time (in seconds) | 20220811 | |
processor_total | int | Processor full value | ||
processor_idle | int | Processor Idle Value | ||
memory_total | int | Total memory capacity (KB) | ||
memory_idle | int | Memory free(KB) |
4.1.3 Interface board /sys_info/interface
- This interface should not be skimped on reading when needed, as it is the only interface that knows if the interface (interface board) hardware is present and if the parameters are correct.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240520 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
uptime | int | The current system uptime, used as a reference, when the interface board uptime more than 30 seconds did not update, then the interface board is considered to not exist | |
interface | array | Interface board basic information Format [{IFACEKV}…], refer to “IFACEKV”. Reference “IFACEKV”. | |
voip_port | array | Default assigned port situation Format: {VOIPPORTKV} |
IFACEKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | slot number | ||
uptime | int | Interface board data update time | ||
model | string | Interface Board Firmware Model | ||
version | string | Interface Board Firmware Version | ||
interface | string | Physical interface types supported by the interface board | ||
product_id | string | Interface Board Hardware Version | 230815 | |
macaddr | string | Interface board mac address | 231221 | |
dahdi_scan | json-string | Interface board interface information Format: [{SPAN:DETAILS}…] Analogue and digital boards are not the same, please test them practically. Note that SPAN | ||
dahdi_port | json-string | Port status information Format: [{SPAN:DETAILS}…] Analogue and digital boards are not the same, please test them actually. Note that SPAN | ||
sip_register | json-string | SIP registration information Format: [{XXX:DETAILS}…] Analogue and digital boards are used differently, please test them actually. | ||
dahdi_analog | json-string | Analogue board port offhook status {channel:status} Example data {“1”: “Onhook”, “2”: “Offhook”, “3”: “Onhook”} | 230224 | |
voltage | json-string | Port voltage Format: {channel:voltage} Example data {“1”: “47”, “2”: “45”, “3”: “47”} | 240313 |
VOIPPORTKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
sip_start | int | SIP assignable port start number | ||
sip_end | int | SIP assignable port end number | ||
rtp_start | int | RTP usable port start number | ||
rtp_end | int | RTP can use the end-of-port number | ||
udptl_start | int | UDPTL can use the port start number | ||
udptl_end | int | UDPTL can use the end-of-port number | ||
sip_anonymous | int | SIP anonymous port number | ||
sip_channel_start | int | SIP channel mode port number | 221208 | |
sip_group_start | int | SIP packet mode port number | 221208 | |
sip_other_start | int | SIP other port number | 221208 |
4.1.3 CDR status /sys_info/cdr
- The data is only available if the cdr function is turned on
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240520 |
limit | string | N | unoccupied | Quantity Format: null (unlimited) or numeric length limit 0-8 | 240520 |
source_tpl | string | N | unoccupied | Associated source_tpl (refer to worker.md) Format: empty (none) Length 0-32 | 240520 |
source | string | N | unoccupied | Associated source (refer to worker.md) Format: empty (none) Length 0-32 | 240520 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | slot number | 230317 | |
source_tpl | string | TPL value | 230317 | |
source | string | SOURCE value | 230317 | |
callerid | string | caller ID | 230317 | |
from | string | caller ID | 230317 | |
from_channel | string | primary call channel | 230317 | |
to | string | called number | 230317 | |
to_channel | string | called channel | 230317 | |
disposition | string | Call status Format: “NO ANSWER” FAILED BUSY ANSWERED CONGESTION UNKNOWN | 230317 | |
start | string | Call start time | 230317 | |
answer | string | response time | 230317 | |
end | string | Overall end time | 230317 | |
billsec | string | Length of response time | 230317 |
4.1.4 Package detection /sys_info/package
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
name | string | N | – | Package name Format: Length 1-64 | 240520 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
name | string | – | Package name Format: empty means not found | 230415 |
version | string | – | Package version e.g. 1.0-1 | 230415 |
4.1.5 API queries /sys_info/api
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
class_name | string | N | unoccupied | API class name Format: length 0-64 0 means all classes | 240520 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
api | array | – | API return information Format {CLASS=>[0,1…]} | 230415 |
4.1.6 Cloud Management Getting System Status /sys_info/device_info
Note: Cloud Management gets the system status as a whitelist function, allowing access without forensic information.
Note: No token is required to access this interface
Note: To prevent hacker DDOS attack, processing request random delay 0-2s
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
device_sn | string | product key (software) | 230601 | |
product | string | Diethylammonium chloride | 230601 | |
product_id | string | Motherboard Hardware Version | 240227 | |
vendor | string | Publisher Name | 231108 | |
website | string | Publisher’s website | 231108 | |
region | string | Country or region 2-digit code | 231108 | |
language | string | Default language 2-digit code | 231108 | |
platform | string | Architecture Type | 230601 | |
device_model | string | Product Model | 230601 | |
firmware_model | string | Firmware Model | 230601 | |
firmware_version | string | Firmware version | 230601 | |
mac_str | string | MAC address | 230601 | |
device_ip | string | Device IP | 230601 | |
interface | string | physical interface | 230601 | |
os_time | string | system time | 230601 | |
uptime | string | runtime | 230601 | |
use_cpu | string | cpu usage | 230601 | |
use_memory | string | memory footprint | 230601 | |
use_storage | string | storage occupancy | 230601 |
4.1.7 web page differential information /sys_info/oem_web
Note: The web page differential information interface is a whitelisted function, allowing access without forensic information.
Note: No token is required to access this interface
Note: To prevent hacker DDOS attack, processing request random delay 0-2s
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
device_model | string | Product Model | 231123 | |
vendor | string | Publisher Name | 231123 | |
vender_cn | string | Publisher Chinese | 231123 | |
style | string | Menu Style Style | 231123 | |
i18n_user | string | i18n Supported Configuration Items | 240109 |
4.2 Systems management
4.2.1 Upload Permission /sys_maintain/upload_permission
- Note: This interface is a firmware uploading interface, you can’t call the /upload interface without calling this interface.
- Note: Uploadable firmware size, 64M RAM <18M, 128M RAM <26M
- Note: If the current available memory of the device is less than the maximum upload value, the low memory mode will be enabled (at this time, the core service is shut down, and will be turned on again after the /upload upload is completed; if the upload process fails, the device can be restored by manually restarting the device).
Client→Server Request
Server→Client Response
4.2.2 Upgrading execution /upload
- Note: You need to call the upload_permission interface to get permission before calling this interface.
- Device stuck: no permission for upload_permission, device out of memory
- HTTP 413: Uploading a file that exceeds the maximum limit
- HTTP 500: device out of memory, forced to terminate the upload
- Note: This interface is a POST form interface, encrypt is multipart/form-data, not a rest api interface.
- Note: Please refer to “Firmware Upload Test Results” in the appendix.
Client→Server Request
POST_NAME | POST_TYPE | Default | Remark | Renew |
---|---|---|---|---|
type | text | – | Upload file type Format: controller interface Note: interface can only be called if the device is in netbus mode | 221117 |
binary | file | – | POST files of type file | 221117 |
keep_sys | text | no | Retain system configuration Format: yes/no | 221117 |
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
msg | string | unoccupied | Return to text content | 221117 |
code | int | – | Returns the code, which conforms to API-defined standards | 221117 |
4.2.3 System Reboot /sys_maintain/sys_reboot
The interface reboots the system at 0.1 second intervals after the return. For netbus mode, the interface board will reboot after the master reboot.
Client→Server Request
Server→Client Response
4.2.4 Restore factory /sys_maintain/sys_reset
Reset overlay, flush disc buffers, and reboot.
Client→Server Request
Server→Client Response
4.2.5 Backup Restore /sys_maintain/backup_restore
Note: The recovery is executed in the background, when executed immediately return success, such as encountered file does not exist, the recovery will not be real execution. Note: The backup data may contain MAC address, if cross-device recovery to other devices, you need to modify the data to delete the MAC to avoid MAC address pollution.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
action | int | Y | – | Action Type Format: 0 (no action) 1 (local backup generation) 2 (local backup recovery) | 240521 |
Server→Client Response
4.2.6 Backup upload /sys_maintain/backup_upload
Note: Uploading a backup file will overwrite the local backup
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
backup_data | string | Y | – | Backup data (base64 data) Format: length 16-524288 (approx. 512K max.) | 240521 |
Server→Client Response
4.2.7 Backup download /sys_maintain/backup_download
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
backup_data | string | – | Backup data (base64 data) Format: length 16-524288 (approx. 512K max.) | 230412 |
4.3 Account management
4.3.1 WEB account password /sys_user/set
- Note: Accounts with level = admin can be modified in any way without restriction (the original password can be filled in arbitrarily).
- Note: For accounts with level ! = admin account “original username” can only be filled in by yourself, and verify that the “original password” is correct.
- Note: CLI account is equivalent to WEB level=admin
- Note: After the modification, the login of the “original user” will be invalidated and you have to log in again.
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
username | string | – | Original username Format: 4-32 characters | |
password | string | – | Original password (MD5) Format: 4-32 characters | |
new_username | string | – | New user name Format: 4-32 characters | |
new_password | string | – | New password (MD5) Format: 4-32 characters | |
new_password_confirm | string | – | New password confirmation (MD5) Format: 4-32 characters |
Server→Client Response
4.3.2 WEB account export /sys_user/export
Note: This will only work if you are currently an admin account.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
list | array | User list Format: [{ULKV}…]. , with reference to “ULKV”. | 231102 |
ULKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
username | string | – | User name Format: 4-32 characters | 231102 |
password | string | – | Password (MD5) Format: 4-32 characters | 231102 |
level | string | – | Level data Format: admin, user, viewer | 231102 |
4.3.3 WEB account import /sys_user/import
Note: It will only work if you support the execution of the account that is currently the admin identity. Note: Importing an account will completely empty the previous account.
Client→Server Request
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
Reference /sys_user/export | 231102 |
Server→Client Response
4.3.4 CLI account passwords /sys_user/cli_passwd_set
Note: CLI passwords cannot be exported because changing passwords is managed by the Linux kernel (for security reasons) and can only be changed, not exported.
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
new_password | string | – | New password (plaintext) Format: 8-32 characters | 220914 |
new_password_confirm | string | – | New password confirmation (plaintext) Format: 8-32 characters | 220914 |
Server→Client Response
4.4 System options
4.4.1 Time settings /sys_option/datetime_set
We use the more precise UTC time expression, please refer to internationalisation.md for details.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
timezone | string | N | UTC | Time zone string, length 64 | 240522 |
ntp_enable | int | N | 1 | Enable NTP time synchronisation, 1 on, 0 off | 240522 |
ntp_server_list | string | N | unoccupied | NTP server address, separated by multiple spaces, length 128 ntp_enable on, can not be empty; other cases can be empty | 240522 |
Server→Client Response
4.4.2 Time reading /sys_option/datetime_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References /sys_option/datetime_set | ||||
timestamp | string | Current system time | ||
datetime_str | string | The time string of the set time zone offset, the front-end according to the current language, formatted to display, for example: date=new Date(“2023-07-05T20:24:52”);date.toLocaleString(“zn-CN”); | 20230707 |
4.4.3 Log settings /sys_option/syslog_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
log_ip | string | N | unoccupied | Log server address Format: null means not enabled, length 0-63 | 240522 |
log_port | int | N | 0 | Log Server Port Format: 0 (off) 1-65535 Remarks: Recommended 514 | 240522 |
conloglevel | int | N | 0 | Kernel log level Format: 8(DEBUG) 7(INFO) 6(NOTICE) 5(WARNING) 4(ERROR) 3(CRIT) 2(ALERT) 1(EMERG) 0(CLOSE) Remarks: 7 is recommended. | 240522 |
Server→Client Response
4.4.4 Log reading /sys_option/syslog_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References sys_option/syslog_set | 220819 |
4.4.5 SSH Settings /sys_option/ssh_set
Note: Returns immediately after execution and is completely effective within a few seconds
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
enable | int | N | 1 | Enable SSH service Format: 0 (cancelled) 1 (enabled) | 240522 |
port | int | N | 3505 | SSH service port Format: 100-65535 | 240522 |
Server→Client Response
4.4.6 SSH Get /sys_option/ssh_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References sys_option/ssh_set | 220914 |
4.4.7 HTTP settings /sys_option/http_set
Note: Returns immediately after execution and takes effect completely within a few seconds Note: If it is a REST API you need to make sure that you get a successful return and jump to the new address, otherwise browser caching will cause problems accessing the old ports Note: If the certificate (sys_security/certs_set) has been updated, you need to execute this interface in order for the new certificate to take effect. Note: If the selected certificate is blank or invalid it will result in http startup failure and loss of all http based services, which will need to be fixed by resetting the ssh/serial port.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
mode | int | N | 0 | HTTP service mode Format: 0 (HTTP) 1 (HTTPS) 2 (Off) | 240522 |
http_port | int | N | 80 | HTTP service port Format: 80-65535 | 240522 |
https_port | int | N | 443 | HTTPS service port Format: 80-65535 | 240522 |
https_pem | int | N | 0 | PEM certificate selection for HTTPS service Format: 0 (default certificate) 1 2 3 4 | 240522 |
Server→Client Response
4.4.8 HTTP Get /sys_option/http_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References sys_option/http_set | 230413 |
4.4.9 Schedule settings /sys_option/schedule_set
Note: If the reboot time is close to the provisioning time, provisioning may fail. It is recommended to set the provision to be executed after startup.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
reboot | int | N | 0 | Restart schedule Format: 0 (close schedule), 1 (daily), 2 (weekly) | 240522 |
reboot_hour | int | N | 0 | (reboot=1/2) Reboot schedule Daily Format: 0-23 (hours) | 240522 |
reboot_dayofweek | int | N | 0 | (reboot=2) reboot schedule Weekly format: 0-6 (0 is Sunday) | 240522 |
Server→Client Response
4.4.10 Schedule read /sys_option/schedule_get
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References sys_option/schedule_set | 230418 |
Server→Client Response
4.4.11 WEB configuration item settings /sys_option/web_set
Note: The i18n_user parameter does not need to be provided in the web page to fill in the configuration items, and is currently only used in CLI mode.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
session_user | int | N | 600 | WEB Login Timeout Configuration Item Format: 120-3600 Unit (sec) | 240522 |
i18n_user | string | N | – | The i18n supports configuration entries Format: 1-64 characters Multiple values separated by spaces, example: “zh en fr pt th ru” | 240522 |
Server→Client Response
4.4.12 WEB CONFIGURATION OPTION GET /sys_option/web_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
References sys_option/web_set | 240109 |
4.5 Statistical testing
4.5.1 ping test /sys_analysis/ping_do
The results need to be obtained using the /sys_analysis/ping_result interface after the test has been issued.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
host | string | N | – | Test address Format: 1-63 characters | 240514 |
count | int | N | 5 | Number of tests Format: 1-100 | 240514 |
size | int | N | 56 | Packet length Format: 56-1024 Units (bytes) | 240514 |
Server→Client Response
4.5.2 ping results /sys_analysis/ping_result
Note: If a ping task has been issued, confirm that the data is ready by calling this interface several times to get the status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Status Format: 0 None 1 Pending 2 Processing 3 Completed Note: Multiple reads are required after completion (flow data). | 230424 |
result | string | unoccupied | URL to download relative address | 230423 |
4.5.3 tracert test /sys_analysis/tracert_do
The results need to be obtained using the /sys_analysis/tracert_result interface after the test has been issued.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
host | string | N | – | Test address Format: 1-63 characters | 240514 |
waittime | int | N | 3 | Sets the time to wait for a response message Format: Range 1-10 | 240514 |
maxhops | int | N | 30 | Setting the maximum number of hops Format: Range 1-255 | 240514 |
Server→Client Response
4.5.4 tracert results /sys_analysis/tracert_result
If a tracert task has been issued, confirm that the data is ready by calling this interface several times to get the status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Status Format: 0 None 1 Pending 2 Processing 3 Completed Note: Multiple reads are required after completion (flow data). | 230424 |
result | string | unoccupied | URL to download relative address | 230423 |
4.5.5 dns test /sys_analysis/dns_do
The results need to be obtained using the /sys_analysis/dns_result interface after the test has been issued.
Note: dns_server does not allow IPv4 addresses starting with 127, if you use OIAD’s own DNS resolution (127.0.0.1), just set dns_server to empty.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
host | string | N | – | Test address Format: 1-63 characters | 240514 |
dns_server | string | N | unoccupied | Domain name servers Format: IPv4 | 240514 |
Server→Client Response
4.5.6 dns results /sys_analysis/dns_result
If a dns task has been issued, confirm that the data is ready by calling this interface multiple times to get status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Status Format: 0 None 1 Pending 2 Processing 3 Completed Note: Multiple reads are required after completion (flow data). | 230424 |
result | string | unoccupied | URL to download relative address | 230423 |
4.5.7 Network capture /sys_analysis/capture_do
- The results need to be obtained using the /sys_analysis/capture_result interface after the test has been issued.
- Note: For netbus mode, it is recommended that the interface be selected only wan
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
interface | string | N | wan | Interface name (basic, logical) Format: wan lan vpn1 mgt | 240514 |
proto | string | N | unoccupied | Filter protocol type Format: ip, arp, udp, tcp Null means ignore. | 240514 |
host | string | N | unoccupied | Filter Address Format: 0-63 null means ignore | 240514 |
port | int | N | 0 | Filter port Format: 0-65535 Ignore when 0 | 240514 |
action | string | N | 0 | Packet capture action Format: 0 stop 1 start | 240514 |
Server→Client Response
4.5.8 Network capture /sys_analysis/capture_result
If a capture task has been issued, confirm that the data is ready by calling this interface multiple times to get status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Status Format: 0 None 1 Pending 2 Processing 3 Completed Note: One-time reading is completed after completion. | 230424 |
result | string | unoccupied | URL to download relative address | 230423 |
4.5.9 Port recording /sys_analysis/record_do
- The results need to be obtained using the /sys_analysis/record_result interface after the test has been issued.
- Note: The recording file format is 8000HZ sample rate, 16-bit, dual-channel (0 for RX, 1 for TX), format PCM16
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240510 |
record | int | N | 2 | Recording Motion Format: 1 Start 2 Stop | 240510 |
record_channel | int | N | 1 | Port number Format: not null, note the restriction, invalid error report | 240510 |
record_limit | int | N | 60 | Duration of recording (seconds) Format: 1-300 Note: 300 seconds reaches a capacity of 5MB, and it is recommended that the duration does not exceed 60 seconds. | 240510 |
Server→Client Response
4.5.10 Recording results /sys_analysis/record_result
If a record task has been issued, confirm that the data is ready by calling this interface several times to get the status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Recording status Format: 0 None 1 Recording in progress 2 Recording finished Note: One-time reading is completed when finished. | 240510 |
result | string | unoccupied | URL to download relative address | 230424 |
4.5.11 Message log /sys_analysis/msglog_do
- Message logs are a means of displaying communication logs on the page
- Note: The device is currently written to allow only 2MB of maximum log space. Even if it is changed in the future, it will not allow third-party settings
- Note: Switching message levels automatically empties the old log data.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240531 |
msglog_level | string | N | disable | Message level Single choice: disable, callflow, debug | 240531 |
Server→Client Response
4.5.12 Message results /sys_analysis/msglog_result
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240531 |
clean | string | N | no | Clear old data before getting data Format: yes/no | 240531 |
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
References /sys_analysis/msglog_do | 240531 | ||||
msglog_result | string | – | unoccupied | msg text data content | 240531 |
4.6 Security settings
4.6.1 WEB Whitelist Settings /sys_security/acl_web_set
Note: This procedure checks the existence of the environment variable client IP address, if there is, addresses list for the empty array does not do anything, otherwise addresses list has the contents of the test whether it contains the client’s IP, if not, report an error.
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
addresses | array | [] | Format: [{LISTKV}…] Reference to “LISTKV”, empty array means empty Maximum number of sys_info/oem macls. |
LISTKV | VAL | Default | Remark |
---|---|---|---|
start | string | – | Starting address Format: IPv4 |
end | string | unoccupied | End address Format: empty means only start, valid IP and start address is in the same range, when the start address is greater than the end address, the start address is automatically used as the end address. |
Server→Client Response
4.6.2 WEB Whitelist Reading /sys_security/acl_web_get
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark |
---|---|---|---|
addresses | array | – | References sys_security/acl_web_set |
4.6.3 Certificate Setting /sys_security/certs_set
Note: If the certificate is renewed and happens to be selected by the http service, the http service needs to be restarted Note: If the certificate is renewed then the VOIP service is automatically restarted
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
certs_iad1 | string | unoccupied | Device certificate pem format: length 0-4096 | 230505 |
certs_iad2 | string | unoccupied | Device certificate pem format: length 0-4096 | 230505 |
certs_iad3 | string | unoccupied | Device certificate pem format: length 0-4096 | 230505 |
certs_iad4 | string | unoccupied | Device certificate pem format: length 0-4096 | 230505 |
certs_calist | string | unoccupied | CA certificate chain Format: length 0-16384 Remarks: CA certificate chain allows multiple CA certificates to exist. | 230505 |
Server→Client Response
4.6.4 Certificate Reading /sys_security/certs_get
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark |
---|---|---|---|
References sys_security/certs_set |
4.7 Automated deployment
Note: There are two more functions: download local configuration/upload local configuration, which need to be realised by the client (WEB). Please consult Ou Gong and refer to the background code icvp-provision for the principle of realisation.
4.7.1 Automatic Deployment Settings /sys_provision/set
- Note: After setting the execution conditions the backend will call icvp-provision to work with icvp-cli to achieve automatic deployment.
- Note: The background provision does not limit the size of the uploaded file, as long as there is still 5M space left in the memory after the upload can be completed (such as insufficient space left in the memory, it will fail).
- Note: Low memory mode will be enabled if the current available memory on the device is less than the upload maximum (at this point the core service is shut down).
- The default master firmware file name is: (pre)(current firmware name).img(post)
- The default interface board firmware file name is: (pre)ixu(mac).img(post)
- The default configuration file is named: (pre)cfg(mac)(post)
- Filename format:
a. Length limitation, note that the maximum length of the full name of the file does not exceed 255 b. Limit the use of special characters in the file name [e.g. space (” “), slash (“/”), backslash (“\”), colon (“:”), asterisk (“*”), question mark (“?”), etc.]. double quotes (‘”‘), pointed brackets (“<“, “>”), etc.]
Main firmware INFO file description (20240226 new), INFO file for the firmware description file can be achieved on the firmware upgrade buildversion control
// INFO design description:
// 1. If the main firmware is called iac-v1102.img, then the INFO file is iac-v1102.info
// 2. When the INFO file cannot be obtained, the firmware upgrade will continue to be processed according to the standard procedure
// 3. If the INFO file is in the wrong format, then the firmware upgrade process will be terminated
// 4. Steps of server-side upgrade opening: first copy info, then copy info // 5. Steps of server-side upgrade closing: first delete img, then delete info To turn off the upgrade on the server, delete the img and then delete the info // 6. Examples of INFO contents: copy the info, then copy the img
// 6.
// 6. INFO内容举例,将xx和yy版升级为zz版:
{“firmware_version_filter”:[“xx”,”yy”],”firmware_version_new”:”zz”}
// INFO内容举例,全部升级为zz版:
{“firmware_ version_filter”:[], “firmware_version_new”: “zz”}
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
auto_switch | string | N | no | Auto Deployment Format: no,boot,day,week | 240313 |
auto_hour | int | N | 0 | Automatic deployment hours Format: 0-23 | 240313 |
auto_dayofweek | int | N | 0 | Automatic deployment of days of the week Format: 0-6 (0 is Sunday) | 240313 |
auto_target | string | N | all | Auto Deployment Scope Format: all, firmware, config | 240313 |
upgrade_type | string | N | tftp | Upgrade method Format: tftp,http,https | 240313 |
upgrade_dhcp | string | N | yes | Enable DHCP 66 to automatically override the server address Format: yes/no | 240313 |
upgrade_user | string | N | unoccupied | HTTP/HTTPS authentication username Format: 0-32 characters | 240313 |
upgrade_pass | string | N | unoccupied | HTTP/HTTPS authentication password Format: 0-32 characters | 240313 |
firmware_url | string | N | unoccupied | Firmware upgrade address (without protocol header) Format: 0-64 characters | 240313 |
firmware_pre | string | N | null | Firmware file prefix Format: 0-32 characters, file name format | 240313 |
firmware_post | string | N | null | Firmware file suffix Format: 0-32 characters, file name format | 240313 |
config_url | string | N | unoccupied | Configuration upgrade address (without protocol header) Format: 0-64 characters | 240313 |
config_pre | string | N | null | Configuration file prefix Format: 0-32 characters, file name format | 240313 |
config_post | string | N | null | Configuration file suffix Format: 0-32 characters, file name format | 240313 |
config_filename | string | N | null | Configuration file name Format: 0-32 characters, file name format | 240313 |
Server→Client Response |
4.7.2 Automated deployment reads /sys_provision/get
Client→Server Request
Server→Client Response
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
Reference /sys_provision/set | 240313 |
4.8 SNMP
- Note: SNMP-related interfaces are only installed by default on ARM platform devices. 7688 platform (iac-v20) counterparts should have icvp-snmp ticked if they want to use it.
4.8.1 SNMP Configuration /sys_snmp/set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
enabled | int | 0 | Switch Format: 0 (off), 1 (on) | |
ip | string | unoccupied | Support ip and ip segment Format: 0-18 characters, empty means no restriction on IP access. | |
port | int | 161 | The open port must be allowed by the firewall, refer to sys_snmp/set Management Station Request Port Format: the default port value is 161, and the range of values is 1025 to 65535. | |
versions | string | v2c | Version selection Format: v1, v2c, v3, multiple selections separated by commas |
Server→Client Response
4.8.2 SNMP Get /sys_snmp/get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
References /sys_snmp/set |
4.9 ocloudclient
- The interface is a plug-in interface, only installed ocloudclient plug-in can be used, you can pass the /sys_info/package interface ocloudclient query
4.9.1 ocloudclient configuration /sys_ocloudclient/set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
disabled | int | 0 | Switch Format: 0 (on), 1 (off) | 230531 |
server_addr | string | openvox.cloud | Server address Support ip and domain name, length 1~100 | 230531 |
server_port | int | 7000 | Open ports must be allowed by the firewall, server port Format: Default port value is 7000, range 1 to 65535. | 230531 |
Server→Client Response
4.9.2 ocloudclient configuration /sys_ocloudclient/get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
References /sys_ocloudclient/set |
4.9.3 ocloudclient cloud management bindings /sys_ocloudclient/bind_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
bind_code | string | Cloud Management Binding Code | 230531 |
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
msg | string | clue | 230531 | |
code | string | 200 is success, not 200 is failure. | 230531 |
4.9.4 ocloudclient get cloud management activation code /sys_ocloudclient/bind_get
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
bind_code | string | Cloud Management Binding Code | 230531 |
4.9.5 ocloudclient status query /sys_ocloudclient/status
Client→Server Request
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
msg | string | Connection status information, web-direct display | 230531 |
4.9.6 ocloudclient http configuration changes taking effect interface /sys_ocloudclient/hooks_do
- For http port and type configuration changes to take effect and restart ocloudclient
Client→Server Request
Server→Client Response
4.9.7 ocloudclient configure xfrpc ssh port /sys_ocloudclient/ssh2_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
server_addr | string | Server address Support ip and domain name, length 1~100 | 231115 | |
remote_port | int | port, the value range is 1 to 65535 | 231115 | |
sign_str | string | Authentication string, md5(sn+openvox+server_addr+port) 32-bit lowercase format | 231115 |
Server→Client Response
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
code | int | 200 for success, 400 or other for failure | 231116 | |
msg | string | Alerts | 231116 | |
data | json | remote_port Set port | 231116 |
5 IAD analogue class
- Note: For the number of slots available, refer to sys_info/oem for instructions.
- Note: For various limited quantities, refer to the sys_info/oem description.
- Note: This class interface can be called only when the current controller is analog, refer to the sys_info/oem description.
- Note: There may be parts of this category of interface settings that have been implemented that need to take effect (/general/apply_do).
5.1 Modelling the global
5.1.1 Driver settings /analog/tel_set
Note: tel includes port global Three-way call fork-tapping rules: (1).threeway_up_only = yes Effect: A –> B, B connects, B taps fork to dial C number, C rings, A plays wait tone; B taps fork again, B resumes call with A, C hangs up (2).threeway_up_only = no Effect: A –> B, B connects, B taps fork to dial C number, C rings, A plays wait tone; B taps fork again, B resumes call with A, C continues to ring; B taps fork again, B resumes call with A, C continues to ring. Threeway_up_only = no effect: A->B, B connects, B taps fork to dial C number, C rings, A plays wait tone; B taps fork again, B resumes the call with A, C continues to ring.
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
driver_custom | string | N | unoccupied | (ALL) Driver Extension Parameters Format: up to 64 characters, nullable | 240131 |
opermode | string | N | FCC | (ALL) Line Impedance Matching Optional: FCC, CHINA, BRAZIL, PHILIPPINES, INDONESIA, NIGERIA, INDIA, ARGENTINA, AUSTRALIA | 240131 |
alawoverride | int | N | 0 | (ALL) Line forced alaw encoding (with bugs) Format: 1 forced 0 not forced | 240131 |
fxshonormode | int | N | 1 | (FXS) FXS impedance mode Format: 1 (opermode in effect) 0 (FCC) | 240131 |
boostringer | int | N | 0 | (FXS) High-voltage ringing Format: 0 (off) 1 (on) Note: If opermode is AUSTRALIA, it is automatically set to 1. | 240131 |
fastringer | int | N | 0 | (FXS) Ringing frequency Format: 0 (20Hz) 1 (25Hz) | 240131 |
signaling | string | N | ls | (ALL) Ports signalling: ks(kewlstart) ls(loopstart) | 240131 |
loadzone | string | N | cn | (ALL) LINE AUDIO REGIONAL CODE Optional: us, au, fr, nl, uk, fi, es, jp, no, at, nz, it, us-old, gr, tw, cl, se, be, sg, il, br, hu, lt, pl, za, pt, ee, mx, in, de, ch, dk, cz, cn, ar, my, th. bg, ve, ph, ru, tr, pa, mo, cr, ae | 240131 |
language | string | N | cn | (ALL) Audio Area Codes Optional: at, au, bg, br, be, ch, cl, cn, cz, de, dk, ee, es, fi, fr, gr, hu, id, il, in, it, lt, jp, mx, my, nl, no, nz, ph, pl, pt, ru, se, sg, th, uk, us, us-old , tw, ve, za | 240131 |
pulsedial | string | N | no | (FXO) Use pulse dialling Format: yes/no | 240131 |
ringtimeout | int | N | 8000 | (FXO) Pre-answer hang-up detection Format: 1000-20000 Units ms | 240131 |
waitfordialtone | int | N | 0 | (FXO) Hang-up and then off-hook dial tone detection Format: 0-20000 Units ms | 240131 |
dialtone_detect | int | N | 10000 | (FXO) Dial tone detection duration after off-hook Format: 0-100000 in ms | 240131 |
busycount | int | N | 4 | (FXO) Busy Tone Detection Match Count Format: 1-16 Note: Less than 4 without configuring busypattern may be incorrectly detected. | 240131 |
busypattern | string | N | unoccupied | (FXO) Busy Tone Detection Cadence Format: null (off) Length 0-64 Note: If not set, auto cadence will be used. | 240131 |
cidstart | string | N | ring | (FXO) Caller ID Timing Format: ring,polarity,polarity_IN,dtmf | 240131 |
cidsignalling | string | N | bell | (FXO) Caller ID signal Format: bell,v23,dtmf | 240131 |
dtmfcidlevel | int | N | 256 | (FXO) Incoming DTMF intensity Format: 128-1024 Note: valid only when cidstart=dtmf, too small leakage too large false detection | 240131 |
port_osi | string | N | 500 | (ALL) Open Switching Interval, valid only at kewlstart, used for switching on by changing the voltage, unit ms, range 100-10000 | 240131 |
port_led_reg | string | N | no | (FXS) Interface lamp SIP registration success is always lit Format: yes/no | 240131 |
port_led_idle | string | N | 0,2000 | (FXS) Interface lamp idle time Format: [on,off] Unit ms Remarks: e.g. 0,2000 long off, integer multiple of 100, the sum of two numbers can be divided by 2000, not 2000,2000 | 240131 |
port_led_nobat | string | N | 1000,1000 | When the FXO connector lamp is not wired Format: [on,off] Unit ms | 240131 |
port_led_offhook | string | N | 500,500 | (FXS) Interface lamp removal time Format: [on,off] Unit ms | 240131 |
port_led_ring | string | N | 100,100 | (FXS) Interface lamp ringing time Format: [on,off] Unit ms | 240131 |
port_led_talk | string | N | 500,500 | (FXS) Interface lamp talk time Format: [on,off] Unit ms | 240131 |
port_led_talkend | string | N | 500,500 | (FXS) Interface lamp call end Format: [on,off] Unit ms | 240131 |
dahdi_pulsedial | int | N | 0 | (FXS) Support Pulse Dialing Optional: 0(no)/1(yes) | 240131 |
dahdi_maxpulsetime | int | N | 200 | (FXS) Maxmum Pulse Time Optional: 16-2000 Recommended <=rxminflash | 240131 |
fxs_dialdebounce | int | N | 64 | (FXS) Off-hook detection de-jitter time Optional: 32 (pulse dialling) 64 96 128 | 240131 |
rxflash | int | N | 1250 | (FXS) Maximum Fork Tap Time Optional: 100-3000 units ms | 240131 |
rxminflash | int | N | 40 | (FXS) Minimum Fork Tap Time Optional: 40-2000 units ms Recommended <=rxflash | 240131 |
firstdigit_timeout | int | N | 10000 | (FXS) First Digit Dial Timeout Optional: 1000-40000 Units ms | 240530 |
interdigit_timeout | int | N | 6000 | (FXS) Inter-bit dialling timeout Optional: 1000-20000 units ms | 240530 |
mwi_hz | int | N | 1 | (FXS) Set MWI waveform frequency Selectable: 1,2,4 | 240418 |
jbenable | string | N | no | (ALL) Jitter buffer on Optional: yes/no | 240131 |
jbmaxsize | int | N | 200 | (ALL) Jitter Maximum Buffer Optional: 10-10000 units ms | 240131 |
jbresyncthreshold | int | N | 1000 | (ALL) Jump frame timestamp on jitter resynchronisation Optional: 10-10000 units ms | 240131 |
jbimpl | string | N | fixed | (ALL) jitter buffer method Optional: fixed (static buffer, jbmaxsize only), adaptive (variable buffer) | 240131 |
jbtargetextra | int | N | 40 | (ALL) Jitter variable new buffer size (valid only in ADAPTIVE) for use in case of sudden peak jitter. Optional: 10-10000 units ms | 240131 |
dtmf_to_total_energy | int | N | 35 | (ALL) DTMF total energy scaling factor Optional: 10-100 | 240131 |
dtmf_gsize | int | N | 120 | (ALL) DTMF Sampling Points per Detection Zone Optional: 80-160 | 240131 |
dtmf_threshold | int | N | 80000000 | (ALL) DTMF Energy Threshold Optional: 80000000-2400000000 | 240131 |
transferremote | string | N | yes | (ALL) Call Transfer to Remote Extension Format: yes/no | 240131 |
threeway_up_only | string | N | yes | (ALL) Three-way call tapping rule (table header description) Format: yes/no, front-end not configured | 240520 |
Server→Client Response
5.1.2 Driver acquisition /analog/tel_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /analog/tel_set description |
5.1.3 VOIP settings /analog/voip_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
user_agent | string | N | OIAD | SIP protocol user-agent string Length: 1-64 Note: This parameter cannot be modified when the user_agent_force of UCI is not empty. | 240228 |
quick_dnssrv_switch | string | N | no | Fast DNSSRV switching Format: yes (yes) no (no) | 240418 |
timer_t1 | int | N | 500 | Transmission time T1 value Format: (ms) 100-10000000 | 240131 |
timer_t2 | int | N | 4000 | Transmission time T2 value Format: (ms) 800-10000000 | 240131 |
allow_tx_hash_in_uri | string | N | no | The “#” sign is not escaped Format: yes (yes) no (no) | 240131 |
timers | string | N | yes | Session Timer (RFC4028) support method Format: yes/no/always/required | 240131 |
timers_min_se | int | N | 90 | Session refresh minimum interval Format: (ms) 90-10000000 | 240131 |
timers_sess_expires | int | N | 1800 | Session refresh maximum interval (must be greater than or equal to the minimum value) Format: (ms) 90-10000000 | 240131 |
g723_rate | string | N | 63 | G723 Rate Optional: 63 (6.3kbps encoding rate) 53 (5.3kbps encoding rate) No field if the device does not support G723 codecs | 240223 |
ilbc_mode | string | N | 30 | iLBC frame duration Optional: 20(20ms) 30(30ms) No field if the device does not support iLBC codecs | 240223 |
sip_anonymous | string | N | no | (pjsip_account) Initiates anonymous SIP inbound Format: yes/no | 240131 |
in_ringtime | int | N | 55 | (dialplan) Incoming call wait timeout Optional: 10-1000 units of s | 240131 |
out_ringtime | int | N | 55 | (dialplan) Outgoing wait timeout Optional: 10-1000 units of s | 240131 |
cadence | array | N | – | FXS Distinctive Ringing Table Format: [c1,c2…. .c10], must be 10 entries Data cN format: r1,s1[,r2,s2…. .r8,s8] Total length not to exceed 64 characters | 240202 |
sip_cid2 | int | N | 0 | (dialplan) Calling number display priority: 0 (FROM), 1 (P-Asserted-Identity) | 240131 |
calltimeout | int | N | 43200000 | (FXO) Call Maximum Limit Format: 0-9999999999 Unit ms 0 for unlimited | 240131 |
net_failover | string | N | yes | (FXS) Disconnect Escape Optional: yes/no Remarks: Automatically call out using the FXO port when the network fails or the call times out | 240131 |
early_media | string | N | no | (dialplan) Enable early_media Format: yes (yes) no (no) | 240312 |
ring_cadence | int | N | 0 | (FXS) Distinctive ringing function uses ringing interval matching, selectable:0-10 0 represents cadence without distinctive ringing | 240407 |
ring_alert_info | array | N | – | (FXS) Distinguish ringing function using alert_info match Empty array means empty, quantity limit 5, format [{k1:v1},{k2:v2}] value range 1-10, example data [{“ring2”: “2”},{“ccc”: “4”}] | 240407 |
ring_caller_id | array | N | – | (FXS) Difference ringing function using caller_id matching, caller_id support prefix matching Empty array means empty, the number of limit 5, format [{k1:v1},{k2:v2}] value range 1-10, example data [{“102”: “2”},{“9002”: “7”}] | 240407 |
Server→Client Response
5.1.4 VOIP get /analog/voip_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
user_agent | Note: The value of this parameter is null when the user_agent_force of UCI is not null. | 240228 | ||
Reference /analog/voip_set |
5.2 Analogue ports
5.2.1 Port actions /analog_port/port_action
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | |
sipid | string | – | String SIP number Format: “channel” for FXS, “group” for FXO. | 220908 |
cmd_register | int | 0 | Corresponding SIP registration action Format: 0 no action, 1 registration, 2 cancellation |
Server→Client Response
5.2.2 Getting port information /analog_port/port_get
- Note: The port configuration data read is the maximum supported data and there are false data
- Note: Always check the result value of sys_info/interface to see if the data is valid.
- For example, for a 1O1S device, it is possible that the FXS has both channel=1 and channel=2 data, while in reality the interface has only channel=1 as FXO, so the reported interface data must be checked.
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 221208 |
type | string | fxs | Type Format: fxo fxs all | 230515 |
enable | string | unoccupied | Filter number is enable Format: yes/no/empty | 230414 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | Slot number Format: not null, note limitations, invalid error report | 221208 | |
fxs | array | FXS table Format: [{POKV}…] Reference to “PSKV”. | 221208 | |
fxo | array | FXO table Format: [{PSKV}…], refer to “POKV”. Reference “POKV”. | 221208 |
PSKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
Refer to the description of analogue_port/fxs_get | 221212 |
POKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
Refer to the description of analog_port/fxo_get | 221212 |
5.2.3 FXS settings /analog_port/fxs_set
- Detects front-end program detection when enable is yes:
- sys_info/interface Check whether the interface board reported data, uptime time and other parameters are valid and reasonable.
- sys_info/interface Check if SPAN=1 and type is analogue in the dahdi_scan of the data reported by the interface board, and check if the corresponding channel is FXS.
- Detection when enable is no: No need to detect as above.
- The recommended interface has an option to set all ports to disable in bulk for easy operation after replacing the board.
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | |
channel | int | – | Port number Format: not null, note the restriction, invalid error report | |
enable | string | no | Enable port Format: yes/no | |
Primarily used for chan_dahdi_channels | ||||
group | string | unoccupied | (FXS) Port grouping Format: contents 4-63 | 240507 |
callwaiting | string | yes | (FXS) Call waiting support switched via hook-flash Format: yes/no | |
threewaycalling | string | yes | (FXS) 3-way call/talk support (need to enable transfer) Format: yes/no Note: Setting to no will send a fork event to the sip server. | 230420 |
transfer | string | yes | (FXS) Call Forwarding Support (need to enable threewaycalling, auto override canpark) Format: yes/no | |
canpark | string | yes | (FXS) Allow resident support (affected by transfer) Format: yes/no | |
callerid_name | string | unoccupied | (FXS) Display name Format: forbidden ‘”<> Fill in, 32-bit length, nullable | 221209 |
cidformat | int | 3 | (FXS) Configuring Caller ID Format: 1 CID Only,2 Display Name Only,3 Display Name and CID | 231115 |
port_profile | int | 0 | (FXS) Bind PORT policy Format: policy number, non-nullable | |
Primarily used for pjsip_accounts | ||||
callerid_num | string | unoccupied | (FXS/SIP) Account name Format: 32-bit length Note: if empty, register is forced to no | 230515 |
from_user | string | unoccupied | (SIP) FROM mandatory account Format: 32-bit length, null (not mandatory) | 220723 |
auth_username | string | unoccupied | (SIP) Authentication account Format: 64-bit length, null Note: If null, use callerid_num instead | 230515 |
auth_password | string | unoccupied | (SIP) Authentication Password Format: 64-bit length, empty | 220723 |
register | string | yes | (SIP) Enable Registration Format: yes/no | |
sip_server_profile | int | 0 | (SIP) Binding Service Policy Format: policy number, not nullable | |
voip_profile | int | 0 | (SIP) Bind VOIP policy Format: policy number, non-nullable | |
send_pai | string | no | (SIP) Add P-Asserted-Identity header on INVITE Format: yes/no | 230523 |
send_rpid | string | no | (SIP) Add Remote Party ID header when INVITE Format: yes/no | 230523 |
user_eq_phone | string | no | (SIP) Add user=phone header when INVITE Format: yes/no | 230523 |
Mainly for AGI | ||||
hotline_num | string | unoccupied | (AGI Dynamic) Hotline number Format: (0-9a-zA-Z+-#*), empty (closed) Length up to 32 digits | |
hotline_delaytime | int | 1 | (AGI Dynamic) Hotline Delay Wait Format: 0-1000 Unit s | |
dnd | int | 0 | (AGI Dynamic) Enable Do Not Disturb Format: 0 (off) 1 (on) Note: The stutter tone is heard when the phone is off the hook to indicate that Do Not Disturb is in operation. | 230509 |
digitmap_profile | int | 0 | (AGI Dynamic) Bind Number Map Policies Format: policy number, not null, note restrictions, invalid error report | 220729 |
ucf | string | unoccupied | (AGI Dynamic) Unconditional Call Forwarding Number Format: length 0-256 bits Null means off Note: DEVICE/RES method of forwarding is allowed and will be processed directly. such as DAHDI/g0. or resonance DAHDI/1 & DAHDI/2. Note: The phone can still only be set to a 16-bit length. | 240404 |
bcf | string | unoccupied | (AGI Dynamic) Busy Call Forwarding Number Format: Length 0-256 digits Empty means off Note: The phone still can only set the length of 16 digits. | 240404 |
nacf | string | unoccupied | (AGI Dynamic) No Answer Call Forwarding Number Format: Length 0-256 digits Null means off Note: The phone can still only be set to 16 digits in length. | 240404 |
send_pani | string | no | (AGI dynamic) Add P-Access-Network-Info header when INVITE Format: yes/no | 230523 |
send_pei | string | no | (AGI dynamic) Add P-Emergency-Info header when INVITE Format: yes/no | 230523 |
Server→Client Response
5.2.4 FXS get /analog_port/fxs_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
channel | int | – | Port number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
sip_listen_port | int | – | (SIP) SIP signalling port | 221115 |
fxs_tpl | string | – | Template type: iadfxs | 221212 |
sip_tpl | string | – | Template type: iadfxs/anon/iadfxo | 221212 |
Refer to /analog_port/fxs_set description |
5.2.5 FXO settings /analog_port/fxo_set
- Detects front-end program detection when enable is yes:
- sys_info/interface Check whether the interface board reported data, uptime time and other parameters are valid and reasonable.
- sys_info/interface Check if SPAN=1 and type is analogue in the dahdi_scan of the data reported by the interface board, and check if the corresponding channel is FXO.
- Detects if the channel in the current channel= is already in use by another fxo group and cannot be duplicated.
- Detection when enable is no: No need to detect as above.
- The recommended interface has an option to set all ports to disable in bulk for easy operation after replacing the board.
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 221208 |
group | string | – | Grouping number Format: not null, note the restriction, invalid error report | 221208 |
enable | string | no | Enable port Format: yes/no | 221208 |
Primarily used for chan_dahdi_channels | ||||
channel | string | unoccupied | (FXO) port Format: multi-port comma separated, length 0-256 Note: port is empty force enable=no Note: avoid channel being present in other enabled fxo’s | 221208 |
port_profile | int | 0 | (FXS) Bind PORT policy Format: policy number, non-nullable | 221208 |
Primarily used for pjsip_accounts | ||||
callerid_num | string | unoccupied | (SIP) Account name Format: 32-bit length Note: if empty, register is forced to no | 230515 |
from_user | string | unoccupied | (SIP) FROM mandatory account Format: 32-bit length, null (not mandatory) | 221208 |
auth_username | string | unoccupied | (SIP) Authentication account Format: 64-bit length, null Note: If null, use callerid_num instead | 230515 |
auth_password | string | unoccupied | (SIP) Authentication Password Format: 64-bit length, empty | 221208 |
register | string | yes | (SIP) Enable Registration Format: yes/no | 221208 |
identify | string | unoccupied | (SIP) IP Direct Table Format: address[:0-65535] Note: comma separated, max 8 entries | 221208 |
identify_prefix | string | unoccupied | (SIP) Called Prefix Format: 32-bit length, nullable | 240219 |
sip_server_profile | int | 0 | (SIP) Binding Service Policy Format: policy number, not nullable | 221208 |
voip_profile | int | 0 | (SIP) Bind VOIP policy Format: policy number, non-nullable | 221208 |
Mainly for AGI | ||||
ip2tel_callee_mode | int | 0 | (AGI) IP2TEL Called Mode Secondary Dialling Format: 0 Disable,1 Enable | 221208 |
ip2tel_callee_policy | string | g | (AGI) IP2TEL Polling Policy Format: g(incremental) G(decremental) r(cyclic incremental) R(cyclic decremental) | 240103 |
tel2ip_callee_mode | int | 1 | (AGI) TEL2IP Called Mode Called Generation Format: 0 Packet Number,1 Port Number,2 Customised | 221208 |
tel2ip_callee | string | unoccupied | (AGI) TEL2IP customised called number Format: length 0-33 bits | 221208 |
callroute_profile | int | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 221208 |
Server→Client Response
5.2.6 FXO Get /analog_port/fxo_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
group | string | – | Grouping number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
sip_listen_port | int | – | (SIP) SIP signalling port | 221208 |
fxo_tpl | string | – | Template type: iadfxo | 221212 |
sip_tpl | string | – | Template type: iadfxs/anon/iadfxo | 221212 |
Refer to /analog_port/fxo_set description |
5.2.7 Port testing /analog_port/port_test
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240201 |
channel | int | Y | – | Port number Format: not null, note the restriction, invalid error report | 240201 |
number | string | N | unoccupied | Test number, for O-port use Format: no more than 64 characters, can be empty | 240201 |
Server→Client Response
5.3 Simulation strategies
5.3.1 Service policy settings /analog_profile/sip_server_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | |
media_encryption | string | no | (RTP) Media enable SRTP format: sdes, no | |
media_encryption_optimistic | string | no | (RTP) Media forced SRTP format: yes/no (auto) | |
registration_expiration | int | 3600 | (SIP) Registration expiry time Format: 10-10000 units s | |
registration_retry_interval | int | 30 | (SIP) Registration Retry Interval Format: 0-2147483647 Units s | 240105 |
registration_max_retries | int | 2147483647 | (SIP) Number of registration retries Format: 0-2147483647 | 240105 |
auth_realm | string | * | (SIP) Authentication domain Format: *(peer-based), other, length 1-64 | 220730 |
aor_qualify_frequency | int | 0 | (SIP) Signalling Incoming Heartbeat Time Format: 0-10000 Unit s | 220723 |
aor_qualify_timeout | int | 60 | (SIP) Signalling heartbeat timeout interval Format: 1-10000 units s | 220723 |
aor_authenticate_qualify | string | no | (SIP) qualify authentication Format: yes/no | 220730 |
sip_port_mode | string | udp | (SIP) Signalling port type Format: udp/tcp/tls | 220723 |
primary_ipaddr | string | unoccupied | (SIP) Primary server address Format: (domain name and IP address standard) 63 characters, nullable Note: If primary_ipaddr is null, no SIP configuration is issued. | 230515 |
primary_sip_port | int | 5060 | (SIP) Primary server signalling port Format: 100-65535 | |
second_ipaddr | string | unoccupied | (SIP) Backup server address Format: (domain name and IP address standard) 63 characters, nullable Primary is null second is automatically forced to null | 221001 |
second_sip_port | int | 5060 | (SIP) Standby server signalling port Format: 100-65535 | |
from_domain | string | unoccupied | (SIP) Field to use the specified URI as the From Header Length: 0-64 | 230605 |
external_boundle | string | unoccupied | (SIP) Service Binding Interface (Basic, Logical, Virtual) Format: wan lan vpn1 alias1 alias2 null | 240202 |
outbound_proxy | string | unoccupied | (SIP) Outgoing Proxy Server Format: (address):(port) address is the address or domain name port is the port Length 0-63 null means no | 230427 |
dns_mode | string | unoccupied | (SIP) DNS mode Format: null (automatically recognises A Record or IP) srv (dnssrv mode) | 230223 |
ice_support | string | no | (SIP) Enable STUN for this server Format: yes/no Remarks: You need to configure the STUN address and enable this parameter to make it valid. | 230504 |
method | string | unoccupied | (SIP) TLS version Format: empty (tlsv1) tlsv1 tlsv1_1 tlsv1_2 sslv2 sslv3 ssv23 | 230508 |
tls_uri | int | 0 | (SIP) URI pattern for TLS Format: 0 (SIP) 1 (SIPS) | 230508 |
tls_pem | int | -1 | (SIP) Device certificate PEM selection for TLS Format: -1 (none) 0 (default) 1 2 3 4 | 230508 |
tls_calist | int | -1 | (SIP) CA certificate chain selection for TLS Format: -1 (off) 0 (enabled) | 230508 |
verify_server | string | no | (SIP) UAC behaviour for TLS verifies the validity of the peer’s certificate Format: yes/no | 230508 |
require_client_cert | string | no | (SIP) UAS behaviour for TLS verifies the validity of the counterpart’s certificate Format: yes/no | 230508 |
identify_mode | string | unoccupied | (SIP) compatibility mode, used to identify, can be extended Format: default value empty string, optional header_cidnum | 240117 |
Server→Client Response
5.3.2 Service Policy Get /analog_profile/sip_server_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /analog_profile/sip_server_get for instructions. |
5.3.3 VOIP policy settings /analog_profile/voip_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | |
allow_transfer | string | yes | (SIP) Allow REFER Format: yes/no | |
sip_udptl | string | yes | (SIP) Enable UDPTL Format: yes/no | 220722 |
sip_udptl_ec | string | redundancy | (SIP) UDPTL error correction Format: none/fec/redundancy | 220722 |
dtmf_mode | string | rfc4733 | (RTP) DTMF mode Format: rfc4733 (improves rfc2833), inband (in-band audio), info (signalling send), auto (prioritises rfc4733 over inband), auto_info (prioritises rfc4733 over info) | |
use_ptime | string | no | (RTP) Use the requested coded packing duration Format: yes/no | |
allow | string | ulaw, alaw, g729, g722 | (RTP) Encoding Preferred Format: 1. Multiple options are comma-separated and sequential 2. Default models: ulaw, alaw, g729, g722 3. Optional models are retrieved from available_codecs in voip_get 4. The page removes the packet duration model configuration | 231220 |
voice_frames_per_tx | int | 2 | Speech frame/TX format: selectable 1, 2, 3, 4, 6 | 231220 |
rtp_keepalive | int | 0 | (RTP) Media Revival Transmission Interval Format: 0-10000 units s | |
rtp_timeout | int | 0 | (RTP) Inactive hang time in OFF HOLD Format: 0-10000 Unit s | |
rtp_timeout_hold | int | 0 | (RTP) Inactive hang time in ON HOLD Format: 0-10000 Unit s |
Server→Client Response
5.3.4 VOIP Policy Get /analog_profile/voip_get
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
available_codecs | string | – | Optional codecs model Example:ulaw,alaw,g729,g722,g723,g726 | 231220 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
References /analog_profile/voip_set |
5.3.5 PORT policy settings /analog_profile/port_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | |
echocancel | string | 128 | (ALL) echo cancellation length (unit ms), front-end implementation, it is recommended to provide only open and close options, no on behalf of the close, read non-no on behalf of the open, (cli is can be set to: 16, 32, 64, 128, no), write open to pass 128 | 231013 |
answeronpolarityswitch | string | no | (ALL) Answer Reverse Pole (FXO receive/FXS generate) Optional: yes/no | |
hanguponpolarityswitch | string | no | (ALL) Pendant Reverse Pole (FXO Receive/FXS Generate) Optional: yes/no | |
rxgain | string | -2.5 | (ALL) Receiving Energy Gain Format: -12.0 to 12.0 in dB | 230426 |
txgain | string | 0.0 | (ALL) Sending Energy Gain Format: -12.0 to 12.0 in dB | |
sendcalleridafter | int | 1 | (FXS) Send Calling Number Method Optional: 0 (before ringing),1 (after first tone),2,3 | |
mwi_enable | string | no | (FXS) Enable MWI Optional: yes/no Note: If callerid_num is not set, it is equivalent to no. | 231124 |
mwitype_number | string | fsk | (FXS) Local number display method Optional: fsk (FSK display) nofsk (off) rpas (FSK sends pulse before display) | 230518 |
mwitype_led | string | no | (FXS) MWI Lighting Message Light Method Optional: no (off) lrev (polarity reversal) hvdc (90V hookup DC) hvac (90V hookup AC) | 230518 |
tx_mwi_sub_enable | string | no | (FXS) Enable MWI subscription Optional: yes/no | 231124 |
tx_mwi_sub_expiry | int | 3600 | (FXS) MWI Subscription Timeout Format: 10-2147483647 | 231124 |
Server→Client Response
5.3.6 PORT Policy Get /analog_profile/port_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
References /analog_profile/port_set |
5.3.7 Digit Map Policy Settings /analog_profile/digitmap_set
- Note: This interface is only used in FXS for number collection.
- Note: This interface is an AGI static function, after the setup needs to have the effective demand
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | |
priority | int | 0 | Count model Format: 0 local priority 1 remote count map (remote mode hotkey disabled) | 220726 |
match_fail | int | 0 | Incomplete match send number Format: 0 off 1 on | |
sharp_asdial | int | 1 | # key as send Format: 0 No 1 Yes | 221216 |
rules | array | – | (Digit Map Rule) Format: [{RSKV}…]. Reference to “RSKV”, empty array means empty Maxdigitmaprule of sys_info/oem. | |
key_sayip | string | *02 | (SYSKEY) broadcast wan IP address Format: asterisk + XX Length 3 digits | 231204 |
key_saylanip | string | *03 | (SYSKEY) broadcast lan IP address Format: asterisk + XX Length 3 digits | 231204 |
key_saymgtip | string | *04 | (SYSKEY) broadcast mgt IP address Format: asterisk + XX Length 3 digits | 231212 |
key_saychid | string | *97 | (SYSKEY) Announcement of channel number Format: asterisk + XX Length 3 digits | 230509 |
key_sayexten | string | *98 | (SYSKEY) Announcement number Format: asterisk + XX Length 3 digits | 230509 |
enable_key_dnd | int | 0 | (CALLKEY) Do not disturb function Format: 0 (enable) 1 (disable) | 230509 |
key_dnd_on | string | *78 | (CALLKEY) Do Not Disturb Enable Format: asterisk + XX Length 3 digits | 230509 |
key_dnd_off | string | *79 | (CALLKEY) Do not disturb close Format: asterisk + XX Length 3 digits | 230509 |
enable_key_ucf | int | 0 | (CALLKEY) Unconditional call forwarding function Format: 0 (enable) 1 (disable) | 230510 |
key_ucf_on | string | *72 | (CALLKEY) Unconditional Call Forwarding On Format: (asterisk + XX) Length 3 digits Dialling Format: hotkey + number (no more than 16 digits) + well number (e.g. turn on sharp_asdial) | 230510 |
key_ucf_off | string | *73 | (CALLKEY) Unconditional Call Forward Close Format: asterisk + XX Length 3 digits | 230510 |
enable_key_bcf | int | 0 | (CALLKEY) Busy call forwarding function Format: 0 (enable) 1 (disable) | 230510 |
key_bcf_on | string | *90 | (CALLKEY) busy call forwarding on Format: asterisk + XX length 3 digits Dialling format: hotkey + number (no more than 16 digits) + well number (e.g. turn on sharp_asdial) | 230510 |
key_bcf_off | string | *91 | (CALLKEY) Busy Call Forward Close Format: Asterisk + XX Length 3 digits | 230510 |
enable_key_nacf | int | 0 | (CALLKEY) No-answer call forwarding function Format: 0 (enable) 1 (disable) | 230510 |
key_nacf_on | string | *92 | (CALLKEY) No Answer Call Forwarding Enabled Format: asterisk + XX Length 3 digits Dialling Format: hotkey + number (no more than 16 digits) + well number (e.g. turn on sharp_asdial) | 230510 |
key_nacf_off | string | *93 | (CALLKEY) No Answer Call Forward Close Format: asterisk + XX Length 3 digits | 230510 |
RSKV | VAL | Default | Remark |
---|---|---|---|
rule | string | – | Routing rules Format: length 1-33 1.”.” can only appear once. Can only appear once and only at the end 2. “#” can only be at the beginning or end 3. “*” is not restricted 4.”[]” cannot be empty [] 5.”[]” only X-X,Digit,*,#* is allowed in “[] |
Server→Client Response
5.3.8 Digit Map Policy Get /analog_profile/digitmap_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /analog_profile/digitmap_set for instructions. |
5.3.9 Call routing policy settings /analog_profile/callroute_set
- Note: This interface needs to be in effect after setting up.
- Note: This policy only works with FXO ports, the relationship between matching conditions is “and”, and the matching conditions are in order.
- Note: Similar to the iptables design, once a match is made, the match is closed and no further matches are processed.
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | 221207 |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | 221207 |
match_fail | int | 0 | (AGI static) Match Failure Handling Format: 1 direct failure 0 direct call | 221207 |
ip2tel | array | – | (AGI static) IP to port Format: [{I2TKV}…]. Reference “I2TKV”, empty array means empty Priority order, quantity limit sys_info/oem maxcallrouterule | 221207 |
tel2ip | array | – | (AGI static) Port to IP Format: [{T2IKV}…], refer to “T2IKV”, empty array means clear Successive order of priority, quantity limit sys_info/oem maxcallrouterule. Reference “T2IKV”, empty array means empty Priority order, quantity limit sys_info/oem maxcallrouterule | 221207 |
IP to Port I2TKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
src | string | unoccupied | Call source device Format: null (ignore)/other (content), length 0-33 | 221215 |
match_callerprefix | string | unoccupied | Calling prefix match Format: empty (ignore)/any (any)/other (content), length 0-33 | |
match_calleeprefix | string | unoccupied | Called prefix match Format: null (ignore)/any (any)/other (content), length 0-33 | |
target | int | 0 | Routing Action Format: 0 deny 1 permit | |
replace_callerdel_prefix | int | 0 | Calling Prefix deletion Format: 0-128 | |
replace_callerdel_suffix | int | 0 | Caller Suffix Deletion Format: 0-128 | |
replace_calleradd_prefix | string | unoccupied | Calling Prefix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleradd_suffix | string | unoccupied | Caller Suffix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleedel_prefix | int | 0 | Called Prefix Deletion Format: 0-64 | |
replace_calleedel_suffix | int | 0 | Called Suffix deletion Format: 0-64 | |
replace_calleeadd_prefix | string | unoccupied | Called Prefix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleeadd_suffix | string | unoccupied | Called Suffix added Format: null (ignore)/other (content), length 0-33 | |
dest | string | unoccupied | Call destination device Format: null (auto)/port number/port grouping number, length 0-33 Note: you can set it arbitrarily or get the number by querying analog_port/port_get Note: if you don’t set it then the default setting prevails | 231229 |
Port to IP T2IKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
src | string | unoccupied | Call source device Format: null (ignore)/other (content), length 0-33 | 221215 |
match_callerprefix | string | unoccupied | Calling prefix match Format: empty (ignore)/any (any)/other (content), length 0-33 | |
match_calleeprefix | string | unoccupied | Called prefix match Format: null (ignore)/any (any)/other (content), length 0-33 | |
target | int | 0 | Routing Action Format: 0 deny 1 permit | |
replace_callerdel_prefix | int | 0 | Calling Prefix deletion Format: 0-128 | |
replace_callerdel_suffix | int | 0 | Caller Suffix Deletion Format: 0-128 | |
replace_calleradd_prefix | string | unoccupied | Calling Prefix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleradd_suffix | string | unoccupied | Caller Suffix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleedel_prefix | int | 0 | Called Prefix Deletion Format: 0-64 | |
replace_calleedel_suffix | int | 0 | Called Suffix deletion Format: 0-64 | |
replace_calleeadd_prefix | string | unoccupied | Called Prefix added Format: null (ignore)/other (content), length 0-33 | |
replace_calleeadd_suffix | string | unoccupied | Called Suffix added Format: null (ignore)/other (content), length 0-33 | |
dest | string | unoccupied | Call destination device Format: null (auto)/port number/port grouping number, length 0-33 Note: you can set it arbitrarily or get the number by querying analog_port/port_get Note: if you don’t set it then the default setting prevails | 231229 |
Server→Client Response
5.3.10 Call Routing Policy Get /analog_profile/callroute_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /analog_profile/callroute_set for instructions. |
6 IAD digital class
- Note: For the number of slots available, refer to sys_info/oem for instructions.
- Note: The policy limits the number, refer to the sys_info/oem description.
- Note: This class interface can be called only if the current interface is digital, refer to sys_info/oem for instructions.
- Note: BRI, PRI, MFCR2 groups are shared.
- SS7 includes: SS7LINK SS7LINKSET
6.1 Digital global
6.1.1 Driver settings /digital/tel_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
driver_custom | string | N | unoccupied | (ALL) Driver Extension Parameters Format: up to 64 characters, nullable | 240131 |
default_linemode | string | N | e1 | (extraface=t1e1 valid) Digital trunk interface type Format: e1,t1,j1 | 240131 |
loadzone | string | N | cn | (ALL) LINE AUDIO REGIONAL CODE Optional: us, au, fr, nl, uk, fi, es, jp, no, at, nz, it, us-old, gr, tw, cl, se, be, sg, il, br, hu, lt, pl, za, pt, ee, mx, in, de, ch, dk, cz, cn, ar, my, th. bg, ve, ph, ru, tr, pa, mo, cr, ae | 240131 |
language | string | N | cn | (ALL) Audio Area Codes Optional: at, au, bg, br, be, ch, cl, cn, cz, de, dk, ee, es, fi, fr, gr, hu, id, il, in, it, lt, jp, mx, my, nl, no, nz, ph, pl, pt, ru, se, sg, th, uk, us, us-old , tw, ve, za | 240131 |
priindication | string | N | outofband | (BRI/PRI) Method of generating BUSY and CONGESTION notifications Format: inband (play tone without answering, not necessarily supported by the other end) outofband (send disconnect message, play tone on the other end) | 240131 |
jbenable | string | N | no | (ALL) Jitter buffer on Optional: yes/no | 240131 |
jbmaxsize | int | N | 200 | (ALL) Jitter Maximum Buffer Optional: 10-10000 units ms | 240131 |
jbresyncthreshold | int | N | 1000 | (ALL) Jump frame timestamp on jitter resynchronisation Optional: 10-10000 units ms | 240131 |
jbimpl | string | N | fixed | (ALL) jitter buffer method Optional: fixed (static buffer, jbmaxsize only), adaptive (variable buffer) | 240131 |
jbtargetextra | int | N | 40 | (ALL) Jitter variable new buffer size (valid only in ADAPTIVE) for use in case of sudden peak jitter. Optional: 10-10000 units ms | 240131 |
dtmf_to_total_energy | int | N | 42 | (ALL) DTMF total energy scaling factor Optional: 10-100 | 240131 |
dtmf_gsize | int | N | 120 | (ALL) DTMF Sampling Points per Detection Zone Optional: 80-160 | 240131 |
dtmf_threshold | int | N | 80000000 | (ALL) DTMF Energy Threshold Optional: 80000000-240000000 | 240131 |
MFCR2 configuration (TODO Note that it will cause the interface board disk to be full, do not implement it for the time being) | 240131 | ||||
mfcr2_call_files | string | N | no | (MFCR2) Whether MFCR2 keeps a log Format: yes, no | 240131 |
mfcr2_logging | string | N | nothing | (MFCR2) MFCR2 log level Format: all error warning debug notice cas mf stack nothing | 240131 |
Server→Client Response
6.1.2 Driver acquisition /digital/tel_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /digital/tel_set description |
6.1.3 VOIP settings /digital/voip_set
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
user_agent | string | N | OIAD | SIP protocol user-agent string Length: 1-64 Note: This parameter cannot be modified when the user_agent_force of UCI is not empty. | 240228 |
quick_dnssrv_switch | string | N | no | Fast DNSSRV switching Format: yes (yes) no (no) | 240418 |
timer_t1 | int | N | 500 | Transmission time T1 value Format: (ms) 100-10000000 | 240131 |
timer_t2 | int | N | 4000 | Transmission time T2 value Format: (ms) 800-10000000 | 240131 |
allow_tx_hash_in_uri | string | N | no | The “#” sign is not escaped Format: yes (yes) no (no) | 240131 |
timers | string | N | yes | Session Timer (RFC4028) support method Format: yes/no/always/required | 240131 |
timers_min_se | int | N | 90 | Session refresh minimum interval Format: (ms) 90-10000000 | 240131 |
timers_sess_expires | int | N | 1800 | Session refresh maximum interval (must be greater than or equal to the minimum value) Format: (ms) 90-10000000 | 240131 |
g723_rate | string | N | 63 | G723 Rate Optional: 63 (6.3kbps encoding rate) 53 (5.3kbps encoding rate) No field if the device does not support G723 codecs | 240223 |
ilbc_mode | string | N | 30 | iLBC frame duration Optional: 20(20ms) 30(30ms) No field if the device does not support iLBC codecs | 240223 |
in_ringtime | int | N | 55 | (dialplan) Incoming call wait timeout Optional: 10-1000 units of s | 240131 |
out_ringtime | int | N | 55 | (dialplan) Outgoing wait timeout Optional: 10-1000 units of s | 240131 |
sip_cid2 | int | N | 0 | (dialplan) Calling number display priority: 0 (FROM), 1 (P-Asserted-Identity) | 240131 |
calltimeout | int | N | 43200000 | Call Maximum Limit Format: 0-9999999999 Unit ms 0 for unlimited | 240131 |
Server→Client Response
6.1.4 VOIP get /digital/voip_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
user_agent | Note: The value of this parameter is null when the user_agent_force of UCI is not null. | 240228 | ||
Reference /digital/voip_set |
6.2 Digital interfaces
6.2.1 Full search /digital_span/span_list
- Note: The port configuration data read is the maximum supported data
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230310 |
type | string | span | Type Format: span bri pri mfcr2 all | 230515 |
enable | string | unoccupied | Filter number is enable Format: yes/no/empty | 230515 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | Slot number Format: not null, note limitations, invalid error report | 230310 | |
span | array | Format: [{KV}…] , refer to digital_span/span_set description | 230314 | |
bri | array | Format: [{KV}…] , refer to digital_span/bri_set description | 230310 | |
pri | array | Format: [{KV}…] , refer to digital_span/pri_set description | 230310 | |
mfcr2 | array | Format: [{KV}…] , refer to digital_span/mfcr2_set description | 230321 |
6.2.2 Reserved positions /digital_span/xxx
6.2.3 SPAN Configuration /digital_span/span_set
- Fillable values for cable distance.
0: 0 db (CSU) / 0-133 feet (DSX-1) 1: 133-266 feet (DSX-1) 2: 266-399 feet (DSX-1) 3: 399-533 feet (DSX-1) 4: 533-655 feet (DSX-1) 5: -7.5db (CSU) 6: -15db ( CSU) 7: -22.5db (CSU)
Client→Server Request
KEY | VAL | REQ | Default | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 230307 |
span | int | Y | – | Interface number Format: not null, note the restriction, invalid error report | 230307 |
timing | string | N | remote | Clock source Format: local, remote | 230307 |
pcm_encoding | string | N | unoccupied | PCM encoding Format: null (default) alaw mulaw Note: MFCR2 mandatory alaw | 230315 |
hardhdlc | int | N | 0 | Whether to enable HDLC encoding and decoding Format: 0 (not enabled) 1 (enabled) | 240612 |
bri_framing | string | N | ccs | (BRI) framing Format: ccs | 230307 |
bri_coding | string | N | ami | (BRI) Line code Format: ami | 230307 |
bri_dchan | int | N | 3 | (BRI) Channel D Format: 1-3 | 230308 |
t1e1_lbo | int | N | 0 | (T1/E1/J1) Cable distance Format: 0 1 2 3 4 5 6 7, fillable values for cable distance (refer to table description) | 240612 |
t1e1_framing | string | N | ccs | (T1/E1/J1) Framing Format: cas(E1) ccs(E1) d4(T1) esf(T1) Note: MFCR2 forces cas to be framed. | 230315 |
t1e1_coding | string | N | hdb3 | (T1/E1/J1) Line code Format: ami(E1/T1) hdb3(E1) b8zs(T1) | 230307 |
t1e1_crc4 | string | N | no | (E1) CRC4 validation Format: yes (E1 only) no | 230307 |
t1e1_type | string | N | pri | (T1/E1/J1) Signalling model Format: pri ss7 mfcr2 Note: mfcr2 can only be set when (digital interface is E1). | 230307 |
t1e1_dchan | int | N | 16 | (T1/E1/J1) D channel PRI format: 1-31 (E1) 1-24 (T1) MFCR2 format: forced 16 SS7 format: forced 0 | 230315 |
Server→Client Response
6.2.4 SPAN get /digital_span/span_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
span | int | – | Interface number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
Reference /digital_span/span_set description |
6.2.5 BRI configuration /digital_span/bri_set
- Can be effective condition: this SPAN has not been used
- Conditions for validity: Hardware SPAN is present
- Conditions for validity: type of span is digital-NT, digital-TE.
- DIGITAL exchange type.
a. national (National ISDN 2) b. ni1 (National ISDN 1) c. dms100 (Nortel DMS100) d. 4ess (AT&T 4ESS) e. 5ess (Lucent 5ESS) f. euroisdn (EuroISDN) g. qsig (Q.SIG)
- End-to-end dialling scheme:
a. from_channel (use CONNECTEDLINE(ton) value) b. unknown c. private d. local e. national f. international
- Send/Receive ISDN Display IE Options.
a. block (does not transmit display text data) b. name_initial (uses display text setup/connection message as group name) c. name_update (displays text notification/facility use in other messages to update name for COLP) d. name (combines initial and updated name options) e. text (passes any of the no text data during the call as an arbitrary display message) using text data as an arbitrary display message)
Client→Server Request
KEY | VAL | REQ | Default | Remark | renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240606 |
span | int | Y | – | Interface number Format: not null, note the restriction, invalid error report | 240606 |
enable | string | N | no | Enable Format: yes/no | 240606 |
Primarily for dahdi_channels | |||||
nsf | string | N | none | ATT Operator Network Special Parameters Format: none sdn megacom tollfreemegacom accunet | 240606 |
switchtype | string | N | euroisdn | DIGITAL exchange type Format: DIGITAL exchange type (refer to table description) | 240606 |
service_message_support | string | N | yes | Enable message service support Format: yes/no | 240606 |
facilityenable | string | N | no | Enable ISDN supplementary service option (e.g. CPE mode to get caller name from facility) Format: yes/no | 240606 |
hold_disconnect_transfer | string | N | no | (PTMP-NT) Allow hold calls to become active when disconnected Format: yes/no | 230321 |
layer1_presence | string | N | ignore | (PTMP) Layer1 mode line down on idle Format: required ignore | 230321 |
layer2_persistence | string | N | unoccupied | (PTMP) Down on Layer2 mode line idle Format: empty (default) keep_up leave_down | 230321 |
signalling | string | N | bri_cpe | Signalling type Format: bri_cpe bri_net bri_cpe_ptmp bri_net_ptmp | 230321 |
pridialplan | string | N | unknown | Dialling plan Format: unknown private local national international | 240606 |
prilocaldialplan | string | N | unknown | Local dialling plan (RARELY) Format: as above | 240606 |
pricpndialplan | string | N | from_channel | End-to-end dialling plan Format: End-to-end dialling plan (refer to table description) | 240606 |
internationalprefix | string | N | unoccupied | Number prefix International format: length 0-16 | 240606 |
nationalprefix | string | N | unoccupied | Number prefix Country Format: length 0-16 | 240606 |
localprefix | string | N | unoccupied | Number prefix Local Format: length 0-16 | 240606 |
privateprefix | string | N | unoccupied | Number Prefix Privacy Format: Length 0-16 | 240606 |
unknownprefix | string | N | unoccupied | Number prefix Unknown Format: length 0-16 | 240606 |
resetinterval | string | N | never | Unused B channel restart period Format: length 0-32 (in s) never (not switched on) Note: many not supported, e.g. Israel Bezeq/UK/China | 240606 |
inband_on_setup_ack | string | N | no | Receive in-band audio at SETUP ACK (Q.SIG must be switched on if overlap is enabled) Format: yes/no | 240606 |
inband_on_proceeding | string | N | no | Receive in-band audio while PROCEEDING Format: yes/no | 240606 |
overlapdial | string | N | no | Stacked dialling Format: incoming outgoing no yes | 240606 |
mcid_send | string | N | no | Send ISDN Malicious Caller ID request on SPAN Format: yes no | 240606 |
force_restart_unavailable_chans | string | N | no | Automatic restart of unavailable channels Format: yes no | 240606 |
hidecallerid | string | N | no | Hide Caller ID Format: yes no | 240606 |
hidecalleridname | string | N | no | Hide caller name Format: yes no | 240606 |
echocancel | string | N | no | Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no | 240606 |
rxgain | string | N | 0.0 | Received energy gain Format: -12.0 to 12.0 in dB | 240606 |
txgain | string | N | 0.0 | Send energy gain Format: -12.0 to 12.0 in dB | 240606 |
group | string | N | 4 | Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63 | 240606 |
display_send | string | N | text | Send display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported | 240606 |
display_receive | string | N | text | Receive display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported | 240606 |
colp_send | string | N | update | Whether to send connect number information when sending connect Format: block connect update | 240606 |
priindication | string | N | inband | PRI Busy and Congestion Indication Method Format: inband outofband | 240606 |
qsigchannelmapping | string | N | physical | Q.SIG channel mapping method Format: physical logical Note: T1 force physical. | 240606 |
cc_qsig_signaling_link_req | string | N | retain | Q.SIG caller signalling link Format: retain release do_not_care | 240611 |
cc_qsig_signaling_link_rsp | string | N | retain | Q.SIG Responder Signalling Link Format: retention release | 240611 |
datetime_send | string | N | no | NET side sends datetime to the CPE side Format: no date date_hh date_hhmm date_hhmmss Note: only NET side supports the | 240606 |
Mainly for AGI | |||||
callroute_profile | int | N | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 240606 |
Server→Client Response
6.2.6 BRI Get /digital_span/bri_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
span | int | – | Interface number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
bri_tpl | string | template | 230321 | |
Reference to /digital_span/bri_set description |
6.2.7 PRI configuration /digital_span/pri_set
- Can be effective condition: this SPAN has not been used
- Conditions for validity: Hardware SPAN is present
- Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
- Can be effective condition: t1e1_type is pri
- DIGITAL exchange type.
a. national (National ISDN 2) b. ni1 (National ISDN 1) c. dms100 (Nortel DMS100) d. 4ess (AT&T 4ESS) e. 5ess (Lucent 5ESS) f. euroisdn (EuroISDN) g. qsig (Q.SIG)
- End-to-end dialling scheme:
a. from_channel (use CONNECTEDLINE(ton) value) b. unknown c. private d. local e. national f. international
- Send/Receive ISDN Display IE Options.
a. block (does not transmit display text data) b. name_initial (uses display text setup/connection message as group name) c. name_update (displays text notification/facility use in other messages to update name for COLP) d. name (combines initial and updated name options) e. text (passes any of the no text data during the call as an arbitrary display message) using text data as an arbitrary display message)
Client→Server Request
KEY | VAL | REQ | Default | Remark | renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240606 |
span | int | Y | – | Interface number Format: not null, note the restriction, invalid error report | 240606 |
enable | string | N | no | Enable Format: yes/no | 240606 |
Primarily for dahdi_channels | |||||
nsf | string | N | none | ATT Operator Network Special Parameters Format: none sdn megacom tollfreemegacom accunet | 240606 |
switchtype | string | N | euroisdn | DIGITAL exchange type Format: DIGITAL exchange type (refer to table description) | 240606 |
service_message_support | string | N | yes | Enable message service support Format: yes/no | 240606 |
facilityenable | string | N | no | Enable ISDN supplementary service option (e.g. CPE mode to get caller name from facility) Format: yes/no | 240606 |
signalling | string | N | pri_cpe | Signalling type Format: pri_cpe pri_net | 230321 |
pridialplan | string | N | unknown | Dialling plan Format: unknown private local national international | 240606 |
prilocaldialplan | string | N | unknown | Local dialling plan (RARELY) Format: as above | 240606 |
pricpndialplan | string | N | from_channel | End-to-end dialling plan Format: End-to-end dialling plan (refer to table description) | 240606 |
internationalprefix | string | N | unoccupied | Number prefix International format: length 0-16 | 240606 |
nationalprefix | string | N | unoccupied | Number prefix Country Format: length 0-16 | 240606 |
localprefix | string | N | unoccupied | Number prefix Local Format: length 0-16 | 240606 |
privateprefix | string | N | unoccupied | Number Prefix Privacy Format: Length 0-16 | 240606 |
unknownprefix | string | N | unoccupied | Number prefix Unknown Format: length 0-16 | 240606 |
resetinterval | string | N | never | Unused B channel restart period Format: length 0-32 (in s) never (not switched on) Note: many not supported, e.g. Israel Bezeq/UK/China | 240606 |
inband_on_setup_ack | string | N | no | Receive in-band audio at SETUP ACK (Q.SIG must be switched on if overlap is enabled) Format: yes/no | 240606 |
inband_on_proceeding | string | N | no | Receive in-band audio while PROCEEDING Format: yes/no | 240606 |
overlapdial | string | N | no | Stacked dialling Format: incoming outgoing no yes | 240606 |
mcid_send | string | N | no | Send ISDN Malicious Caller ID request on SPAN Format: yes no | 240606 |
force_restart_unavailable_chans | string | N | no | Automatic restart of unavailable channels Format: yes no | 240606 |
hidecallerid | string | N | no | Hide Caller ID Format: yes no | 240606 |
hidecalleridname | string | N | no | Hide caller name Format: yes no | 240606 |
echocancel | string | N | no | Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no | 240606 |
rxgain | string | N | 0.0 | Received energy gain Format: -12.0 to 12.0 in dB | 240606 |
txgain | string | N | 0.0 | Send energy gain Format: -12.0 to 12.0 in dB | 240606 |
group | string | N | 4 | Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63 | 240606 |
display_send | string | N | text | Send display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported | 240606 |
display_receive | string | N | text | Receive display Format: send/receive ISDN display IE options (refer to table description) Note: only NET side supported, cpe and Q.SIG not supported | 240606 |
colp_send | string | N | update | Whether to send connect number information when sending connect Format: block connect update | 240606 |
priindication | string | N | inband | PRI Busy and Congestion Indication Method Format: inband outofband | 240606 |
qsigchannelmapping | string | N | physical | Q.SIG channel mapping method Format: physical logical Note: T1 force physical. | 240606 |
cc_qsig_signaling_link_req | string | N | retain | QSIG Calling party retains signalling link after call completion Format: retain release do_not_care | 240606 |
cc_qsig_signaling_link_rsp | string | N | retain | QSIG Responding party retains signalling after call completion Format: retain release | 240606 |
datetime_send | string | N | no | NET side sends datetime to the CPE side Format: no date date_hh date_hhmm date_hhmmss Note: only NET side supports the | 240606 |
Mainly for AGI | |||||
callroute_profile | int | N | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 240606 |
Server→Client Response
6.2.8 PRI Get /digital_span/pri_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
span | int | – | Interface number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
pri_tpl | string | template | 230321 | |
Refer to /digital_span/pri_set description |
6.2.9 MFCR2 configuration /digital_span/mfcr2_set
- Can be effective condition: this SPAN has not been used
- Conditions for validity: Hardware SPAN is present
- Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
- Can be effective condition: t1e1_type is mfcr2
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230321 |
span | int | – | Interface number Format: not null, note the restriction, invalid error report | 230321 |
enable | string | no | Enable Format: yes/no | 230321 |
Primarily for dahdi_channels | ||||
group | string | 4 | Binding group (PRI/MFCR2/BRI shared) Format: contents 4-63 | 230321 |
mfcr2_variant | string | cn | The accompanying signalling follows the international norms Format: ar br cn cz co ec id itu mx ph ve | 230321 |
mfcr2_get_ani_first | string | no | Obtain an ANI before obtaining DNIS (required by some telcos) Format: yes no | 230321 |
mfcr2_max_ani | int | 10 | Maximum number of ANI bits requested Format: 0-64 | 230321 |
mfcr2_max_dnis | int | 6 | Maximum number of DNIS bits requested Format: 0-64 | 230321 |
mfcr2_category | string | n_s… | Inbound Subscription Class Format: (default) national_subscriber national_priority_subscriber international_subscriber international_priority_subscriber | 230321 |
mfcr2_mfback_timeout | int | -1 | MF timeout Unit (ms) Format: -1 (default) Less than 500 not recommended Range -1 to 10000 | 230321 |
mfcr2_metering_pulse_timeout | int | -1 | Pulse timeout Unit (ms) Format: -1 (default) Less than 500 is not recommended Range -1 to 10000 | 230321 |
mfcr2_skip_category | string | no | Skip Request Calling Class and ANI Format: yes no | 230321 |
mfcr2_double_answer | string | no | Supports double answer format: yes no | 230321 |
echocancel | string | no | Echo cancellation length (in ms) Selectable: 16, 32, 64, 128, no | 230613 |
rxgain | string | 0.0 | Received energy gain Format: -12.0 to 12.0 in dB | 230321 |
txgain | string | 0.0 | Send energy gain Format: -12.0 to 12.0 in dB | 230321 |
Mainly for AGI | ||||
callroute_profile | int | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 230321 |
Server→Client Response
6.2.8 MFCR2 get /digital_span/mfcr2_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
span | int | – | Interface number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
mfcr2_tpl | string | template | 230321 | |
Reference /digital_span/mfcr2_set description | 230321 |
6.3 Digital SS7
6.3.1 Full search /digital_ss7/ss7_list
- Note: The port configuration data read is the maximum supported data
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230320 |
type | string | linkset | Type Format: linkset link all | 230515 |
enable | string | unoccupied | Filter number is enable Format: yes/no/empty | 230515 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | Slot number Format: not null, note limitations, invalid error report | 230320 | |
linkset | array | Format: [{KV}…] , refer to digital_ss7/linkset_set description | 230320 | |
link | array | Format: [{KV}…] , refer to digital_ss7/link_set description | 230320 |
6.3.2 Reservation /digital_ss7/xxx
6.3.3 LINKSET settings /digital_ss7/linkset_set
- LINKSETs are numbered from 1 and the total number available is the same as maxspans in sys_info/interface
- LINKSET doesn’t need to set enable or not, it will be enabled automatically only when it is associated with a link and the link is in effect.
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230313 |
linkset | int | – | LINKSET NUMBER Format: not null, note restrictions, invalid report error | 230313 |
Primarily for ss7_linkset | ||||
enable_st | string | no | Enable end-of-pulsing (not required if receiving address is complete) Format: yes no | 230313 |
use_connect | string | no | Replying to an incoming call using CON Format: yes(CON) no(ACM/ANM) | 230313 |
hunting_policy | string | even_mru | CIC search principle Format: even_mru (nearest even number) odd_lru seq_lth seq_htl | 230313 |
subservice | string | auto | Sub-service Format: national international auto or dec/hex value, auto means get from first received SLTM Length 1-16 | 230313 |
variant | string | itu | Dot-code digit variant Format: itu (14 bits) china (24 bits) | 230313 |
opc | string | 0x6 | Source code value Format: DEC/HEX value Length 1-32 | 230315 |
dpc | string | 0x5 | Destination code value Format: DEC/HEX value Length 1-32 | 230315 |
Mainly for AGI | ||||
callroute_profile | int | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 230313 |
Server→Client Response
6.3.4 LINKSET get /digital_ss7/linkset_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
linkset | int | – | LINKSET NUMBER Format: not null, note restrictions, invalid report error |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
linkset_tpl | string | – | Template type: iadss7 | 230315 |
Refer to /digital_ss7/linkset_set description |
6.3.5 LINK settings /digital_ss7/link_set
- Can be effective condition: this SPAN has not been used
- Conditions for validity: Hardware SPAN is present
- Conditions for validity: the type of the span is digital-T1,digital-J1,digital-E1.
- Can be effective condition: t1e1_type is ss7
- SPANs are numbered from 1 and the total number available is the same as maxspans in sys_info/interface
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230315 |
span | int | – | Interface number Format: not null, note the restriction, invalid error report | 230315 |
enable | string | no | Enable Format: yes/no | 230315 |
Mainly used for ss7_link ss7_host | ||||
linkset | int | 1 | Binding LINKSET number Format. | 230315 |
schannel | int | 16 | Signalling channel Format: 0 (indicates none) Range 1-31 (E1) 1-24 (T1/J1) | 230315 |
channels | string | auto | Audio channels Format: auto (automatic) Empty (means none) Custom (length 0-32) auto: auto-generated Empty: no channels Custom: range 1-31 (E1) 1-24 (T1) e.g. 1-15,17-31 | 230316 |
firstcic | string | auto | CIC start bit Format: auto (automatic) Custom (length 0-6) Remarks: under the same linkset (e1) one port is 1, two ports 33, etc. | 230316 |
echocancel | string | no | Echo cancellation switch Format: no 31speech (transmission median 3.1khz) allways | 230315 |
echocan_train | int | 300 | Echo training period Format: Range 10-1000 in msec. | 230315 |
echocan_taps | string | 128 | Echo cancellation TAPS (ms=taps/8) Format: 32 64 128 256 | 230315 |
rx_gain | string | 0.0 | Received energy gain Format: -12.0 to 12.0 in dB | 230315 |
tx_gain | string | 0.0 | Send energy gain Format: -12.0 to 12.0 in dB | 230315 |
Server→Client Response
6.3.6 LINK get /digital_ss7/link_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
span | int | – | Interface number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
link_tpl | string | – | Template type: iadss7 | 230315 |
Refer to /digital_ss7/link_set description |
6.4 VOIP Settings
6.4.1 Full search /digital_voip/voip_list
- Note: The port configuration data read is the maximum supported data
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230309 |
type | string | trunk | Type Format: trunk all | 230309 |
enable | string | unoccupied | Filter number is enable Format: yes/no/empty | 230515 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | Slot number Format: not null, note limitations, invalid error report | 230309 | |
trunk | array | TRUNK table Format: [{VTKV}…] Reference “VTKV”. | 230309 |
VTKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
Refer to digital_trunk/trunk_get description | 230309 |
6.4.2 VOIP actions /digital_voip/voip_action
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230309 |
sipid | string | – | String SIP number Format: SIP number (trunk) No. | 230309 |
cmd_register | int | 0 | Corresponding SIP registration action Format: 0 no action, 1 registration, 2 cancellation | 230309 |
Server→Client Response
6.4.3 TRUNK configuration /digital_voip/trunk_set
- sys_info/maxsiptrunk limits total amount that can be set
Client→Server Request
KEY | VAL | Default | Remark | renew |
---|---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report | 230309 |
trunk | int | – | Relay number Format: non-null, note restrictions, invalid error message | 230309 |
enable | string | no | Enable Format: yes/no | 230309 |
Mainly used for pjsip_accounts account | ||||
callerid_num | string | unoccupied | (SIP) Account name Format: 32-bit length | 230309 |
from_user | string | unoccupied | (SIP) FROM mandatory account Format: 32-bit length, null (not mandatory) | 230309 |
auth_username | string | unoccupied | (SIP) Authentication Account Format: 64-bit length, null | 230309 |
auth_password | string | unoccupied | (SIP) Authentication Password Format: 64-bit length, empty | 230309 |
register | string | yes | (SIP) Enable Registration Format: yes/no | 230309 |
identify | string | unoccupied | (SIP) IP Direct Table Format: address[:0-65535] Note: comma separated, max 8 entries | 230309 |
sip_server_profile | int | 0 | (SIP) Binding Service Policy Format: policy number, not nullable | 230309 |
voip_profile | int | 0 | (SIP) Bind VOIP policy Format: policy number, non-nullable | 230309 |
Mainly for AGI | ||||
callroute_profile | int | 0 | (AGI) Bind Call Routing Policy Format: policy number, non-nullable | 230309 |
Server→Client Response
6.4.4 TRUNK get /digital_voip/trunk_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
slotnum | int | – | Slot number Format: not null, note limitations, invalid error report |
trunk | int | – | Relay number Format: non-null, note restrictions, invalid error message |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
sip_listen_port | int | – | (SIP) SIP signalling port | 230309 |
sip_tpl | string | – | Template type: iadtrunk | 230309 |
Refer to /digital_voip/trunk_set for instructions. |
6.5 Digital Strategy
6.5.1 Service policy settings /digital_profile/sip_server_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | 230309 |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | 230309 |
media_encryption | string | no | (RTP) Media enable SRTP format: sdes, no | 230309 |
media_encryption_optimistic | string | no | (RTP) Media forced SRTP format: yes/no (auto) | 230309 |
registration_expiration | int | 3600 | (SIP) Registration expiry time Format: 10-10000 units s | 230309 |
registration_retry_interval | int | 30 | (SIP) Registration Retry Interval Format: 0-2147483647 Units s | 240105 |
registration_max_retries | int | 2147483647 | (SIP) Number of registration retries Format: 0-2147483647 | 240105 |
auth_realm | string | * | (SIP) Authentication domain Format: *(peer-based), other, length 1-64 | 230309 |
aor_qualify_frequency | int | 0 | (SIP) Signalling Incoming Heartbeat Time Format: 0-10000 Unit s | 230309 |
aor_qualify_timeout | int | 60 | (SIP) Signalling heartbeat timeout interval Format: 1-10000 units s | 230309 |
aor_authenticate_qualify | string | no | (SIP) qualify authentication Format: yes/no | 230309 |
sip_port_mode | string | udp | (SIP) Signalling port type Format: udp/tcp/tls | 230309 |
primary_ipaddr | string | unoccupied | (SIP) Primary server address Format: (domain name and IP address standard) 63 characters, nullable | 230309 |
primary_sip_port | int | 5060 | (SIP) Primary server signalling port Format: 100-65535 | 230309 |
second_ipaddr | string | unoccupied | (SIP) Backup server address Format: (domain name and IP address standard) 63 characters, nullable Primary is null second is automatically forced to null | 230309 |
second_sip_port | int | 5060 | (SIP) Standby server signalling port Format: 100-65535 | 230309 |
from_domain | string | unoccupied | (SIP) Field to use the specified URI as the From Header Length: 0-64 | 230605 |
external_boundle | string | unoccupied | (SIP) Service Binding Interface (Basic, Logical, Virtual) Format: wan lan vpn1 alias1 alias2 null | 240202 |
dns_mode | string | unoccupied | (SIP) DNS mode Format: null (automatically recognises A Record or IP) srv (dnssrv mode) | 230309 |
outbound_proxy | string | unoccupied | (SIP) Outgoing Proxy Server Format: (address):(port) address is the address or domain name port is the port Length 0-63 null means no | 230427 |
ice_support | string | no | (SIP) Enable STUN for this server Format: yes/no Remarks: You need to configure the STUN address and enable this parameter to make it valid. | 230504 |
method | string | unoccupied | (SIP) TLS version Format: empty (tlsv1) tlsv1 tlsv1_1 tlsv1_2 sslv2 sslv3 ssv23 | 230508 |
tls_uri | int | 0 | (SIP) URI pattern for TLS Format: 0 (SIP) 1 (SIPS) | 230508 |
tls_pem | int | -1 | (SIP) Device certificate PEM selection for TLS Format: -1 (none) 0 (default) 1 2 3 4 | 230508 |
tls_calist | int | -1 | (SIP) CA certificate chain selection for TLS Format: -1 (off) 0 (enabled) | 230508 |
verify_server | string | no | (SIP) UAC behaviour for TLS verifies the validity of the peer’s certificate Format: yes/no | 230508 |
require_client_cert | string | no | (SIP) UAS behaviour for TLS verifies the validity of the counterpart’s certificate Format: yes/no | 230508 |
Server→Client Response
6.5.2 Service Policy Get /digital_profile/sip_server_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /digital_profile/sip_server_get for instructions. |
6.5.3 VOIP policy settings /digital_profile/voip_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | 230309 |
name | string | unoccupied | Strategy name Format: 32 characters, nullable | 230309 |
allow_transfer | string | yes | (SIP) Allow REFER Format: yes/no | 230309 |
sip_udptl | string | yes | (SIP) Enable UDPTL Format: yes/no | 230309 |
sip_udptl_ec | string | redundancy | (SIP) UDPTL error correction Format: none/fec/redundancy | 230309 |
dtmf_mode | string | rfc4733 | (RTP) DTMF mode Format: rfc4733 (improves rfc2833), inband (in-band audio), info (signalling send), auto (prioritises rfc4733 over inband), auto_info (prioritises rfc4733 over info) | 230309 |
use_ptime | string | no | (RTP) Use the requested coded packing duration Format: yes/no | 230309 |
allow | string | ulaw, alaw, g729, g722 | (RTP) Encoding Preferred Format: 1. Multiple options are comma-separated and sequential 2. Default models: ulaw, alaw, g729, g722 3. Optional models are retrieved from available_codecs in voip_get 4. The page removes the packet duration model configuration | 240506 |
voice_frames_per_tx | int | 2 | Speech frame/TX format: selectable 1, 2, 3, 4, 6 | 240506 |
rtp_keepalive | int | 0 | (RTP) Media Revival Transmission Interval Format: 0-10000 units s | 230309 |
rtp_timeout | int | 0 | (RTP) Inactive hang time in OFF HOLD Format: 0-10000 Unit s | 230309 |
rtp_timeout_hold | int | 0 | (RTP) Inactive hang time in ON HOLD Format: 0-10000 Unit s | 230309 |
Server→Client Response
6.5.4 VOIP Policy Get /digital_profile/voip_get
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | |
available_codecs | string | – | Optional codecs model Example:ulaw,alaw,g729,g722,g723,g726 | 240506 |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
References /digital_profile/voip_set |
6.5.5 Call Route Settings /digital_profile/callroute_set
- Note: This interface needs to be in effect after setting up.
- Note: the relationship between the matching conditions is “and”, matching conditions are in order.
- Note: Similar to the iptables design, once a match is made, the match is closed and no further matches are processed.
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report | 230309 |
name | string | unoccupied | Name Format: 32 characters, nullable | 230309 |
match_tech | string | unoccupied | (AGI static) Failed spare line Format: null (disabled) DAHDI (contains bri/pri/mfcr2) SS7 PJSIP | 230322 |
match_dest | string | unoccupied | (AGI static) Destination device Format: null (forbidden) Length 0-33 DAHDI channel: (chid), e.g. 33 DAHDI grouping: (g/G/r/R)(group), e.g. g4 SS7 format: (linksetid), e.g. 0 PJSIP format: (sipid), e.g. 1 | 230322 |
rules | array | – | (AGI static) Routing rule Format: [{CRRKV}…]. Reference “CRRKV” Empty array means empty Priority order, quantity limit sys_info/oem maxcallrouterule | 230322 |
Routing Rules CRRKV | VAL | Default | Remark | Renew |
---|---|---|---|---|
rule_name | string | unoccupied | Rule name Format: 32 characters, nullable | 240605 |
src_tech | string | unoccupied | Call source type Format: null (forbidden) DAHDI (contains bri/pri/mfcr2) SS7 PJSIP | 240605 |
src | string | unoccupied | Call source device Format: null (ignore)/other (content), length 0-33 | 230309 |
match_callerprefix | string | unoccupied | Calling prefix match Format: empty (ignore)/any (any)/other (content), length 0-33 | 230309 |
match_calleeprefix | string | unoccupied | Called prefix match Format: null (ignore)/any (any)/other (content), length 0-33 | 230309 |
target | int | 0 | Routing Action Format: 0 deny 1 permit | 230309 |
replace_callerdel_prefix | int | 0 | Calling Prefix deletion Format: 0-128 | 230309 |
replace_callerdel_suffix | int | 0 | Caller Suffix Deletion Format: 0-128 | 230309 |
replace_calleradd_prefix | string | unoccupied | Calling Prefix added Format: null (ignore)/other (content), length 0-33 | 230309 |
replace_calleradd_suffix | string | unoccupied | Caller Suffix added Format: null (ignore)/other (content), length 0-33 | 230309 |
replace_calleedel_prefix | int | 0 | Called Prefix Deletion Format: 0-64 | 230309 |
replace_calleedel_suffix | int | 0 | Called Suffix deletion Format: 0-64 | 230309 |
replace_calleeadd_prefix | string | unoccupied | Called Prefix added Format: null (ignore)/other (content), length 0-33 | 230309 |
replace_calleeadd_suffix | string | unoccupied | Called Suffix added Format: null (ignore)/other (content), length 0-33 | 230309 |
dest_tech | string | unoccupied | Destination device type Format: null (forbidden) DAHDI (includes bri/pri/mfcr2) SS7 PJSIP | 230322 |
dest | string | unoccupied | Destination device Format: null (forbidden) Length 0-33 DAHDI channel: (chid), e.g. 33 DAHDI group: (g/G/r/R)(group), e.g. g4 SS7 format: (linksetid), e.g. 0 PJSIP format: (sipid), e.g. 1 | 230322 |
Server→Client Response
6.5.6 Call Route Get /digital_profile/callroute_get
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
profile | int | – | Strategy number Format: not null, note the restriction, invalid error report |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /digital_profile/callroute_set for instructions. |
6.5 Numerical statistical tests
6.5.1 Signalling capture /digital_analysis/signaling_capture_do
- The results are obtained after the test is sent using the /digital_analysis/signaling_capture_result interface.
- Maximum packet size 2M
Client→Server Request
KEY | VAL | REQ | DEF | Remark | Renew |
---|---|---|---|---|---|
slotnum | int | Y | – | Slot number Format: not null, note limitations, invalid error report | 240611 |
signaling_capture | int | N | 2 | Action Format: 1 Start 2 Stop | 240611 |
type | string | N | pri | Type Format: pri ss7 | 240611 |
Server→Client Response
6.5.2 Signalling capture results /digital_analysis/signaling_capture_result
If a record task has been issued, confirm that the data is ready by calling this interface several times to get the status.
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
status | int | 0 | Status Format: 0 None 1 In Progress 2 Finished Note: One-time reading is completed after completion. | 240611 |
result | string | unoccupied | URL to download relative address | 240611 |
slotnum | int | 0 | slot number | 240611 |
signaling_capture_channel | string | unoccupied | Signalling channels for grabbing packets, multiple separated by commas | 240611 |
type | string | pri | Catch type | 240611 |
7 IAD General Classes
- Note: The number of slots available and whether the slot number starts at -1 or 0, refer to sys_info/oem for instructions.
- Note: The policy limits the number, refer to the sys_info/oem description.
7.1 Global functions
7.1.1 Effective acquisition /general/apply_get
- Note: Returns a list of what needs to take effect. This interface is like some routers or some large IAD’s products, when part of the operation is done, their interface will have a button for you to press to take effect (pressing it is executing apply_do).
- Note: It is recommended that the interface automatically call this interface detection at certain intervals and the interface prompts the effective banner, which will take effect after pressing the key to confirm.
- Note: Because there are some ports that have a need to take effect, but other parts do not, in order to simplify the front-end processing, it is the most suitable approach to use an interval to call this interface once
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
Reference /general/apply_set description |
7.1.2 Effective settings /general/apply_set
- Note: setting through this interface changes the behaviour of apply_do and apply_get
- Note: Mainly used for front-end implementations to force network or VOIP reboot
- Note: If only one parameter is passed to this interface, the other parameters will be ignored (neither 0 nor 1).
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
network | int | 0 | Network modification required to take effect Format: 0 Not required 1 Required | 221114 |
voip | int | 0 | VOIP modification required to take effect Format: 0 Not required 1 Required | 221114 |
Server→Client Response
7.1.3 Effective implementation /general/apply_do
Note: Execution to take effect will reboot the network or VOIP, and will be modified to 0 when finished
Client→Server Request
Server→Client Response
7.1.4 Policy Summary /general/profile_get
- Note: This interface is used to read out policy-specific information (profile number and name string)
- Note: Summary of the use of the need to consult the development engineers, such as non-existent need to discuss the development of engineering is to give support!
// The following is a sample policy summary
{“point”: “analog”, “type”: “sip_server”} // Emulates a SIP server
{“point”: “analog”, “type”: “voip”} // Emulates a voip options policy
{“point”: “analog”, “type”:”” port”} // Emulates a port options policy {“point”: “analog”, “type”:””
port”} // Analogue port option policy {“point
“: “analog”, “type”: “digitmap”} // Analogue digitmap policy
Client→Server Request
KEY | VAL | Default | Remark |
---|---|---|---|
point | string | – | The location of the policy. Format: analog valid only if sys_info/oem interface is analog digital valid only if sys_info/oem interface is digital |
type | string | – | Policy number Format: described by each policy interface No more than 32 characters |
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
list | array | Format: [{‘profile’:”,’name’:”}…] |
7.2 Global settings
7.2.1 Fax settings /general_option/fax_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
t38_modem | string | v17, v27, v29 | Modem type Format: v17/v27/v29, comma-separated multiple choices possible | |
t38_maxrate | string | 14400 | Maximum rate Format: 14400/9600/7200/4800/2400 When the maximum rate is smaller than the minimum rate, the minimum rate is automatically forced to be used as the maximum rate. | 221001 |
t38_minrate | string | 7200 | Minimum rate Format: 14400/9600/7200/4800/2400 | |
t38_ecm | string | no | Turn on error checking Format: yes/no | |
t38_negotiate_both | string | no | Enable automatic two-way negotiation Format: yes/no | |
t38_detect_timeout | int | 0 | Detect Fax Tone Gateway Mode Duration Format: 0-1000 in s |
Server→Client Response
7.2.2 Fax Get /general_option/fax_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Reference to /general_option/fax_set description |
7.2.3 QoS settings /general_option/qos_set
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
tos_audio | int | 0 | RTP Audio TOS Value Format: 0-255 | 220915 |
tos_signal | int | 0 | SIP signalling TOS value Format: 0-255 | 220915 |
Server→Client Response
7.2.4 QoS Get /general_option/qos_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /general_option/qos_set description |
7.2.5 VOIP settings /general_option/voip_set
- Note: The port setting method and port will be updated automatically after modifying the port
- Note: The sip_channel_start in the voip assignment is automatically assigned based on the slot (refer to sys_info/interface interface to get the exact assignment of each slotnum)
- Note: digital does not currently support single port mode
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
sip_mode | int | 0 | FXS listening mode for SIP Format: 0 (continuous multi-port) 1 (single port, valid for FXS only) | 230310 |
sip_start | int | 30000 | SIP start port Format: 1000-65000 | 221115 |
sip_unregister_mode | int | 0 | (SIP) SIP logout on device reboot Format: 0 (off) 1 (on) | 230420 |
rtp_start | int | 10000 | RTP start port Format: 1000-65000 Note: Need to be spaced with SIP to avoid overlap, it is recommended that the interval of more than 1W | 221115 |
icesupport | string | no | STUN on for RTP Format: yes/no Note: Configuration must be turned on in sip for this to take effect. | 230504 |
stunaddr | string | unoccupied | STUN address for RTP Format: length 0-63 characters [addr]:[port] Remarks: null is off, port default 3478 | 230503 |
Server→Client Response
7.2.6 VOIP Get /general_option/voip_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Reference /general_option/voip_set description |
7.2.7 CDR settings /general_option/cdr_set
Note: For CDR data viewing, please call interface/sys_info/cdr Note: To improve FLASH life, CDR is only retained in memory and lost on reboot
Client→Server Request
KEY | VAL | Default | Remark | Renew |
---|---|---|---|---|
cdr_enable | string | no | Enable CDR recording Format: yes/no | 230317 |
cdr_filter | string | ANSWERED | Filtered data Format: empty (no filtering) “NO ANSWER” (no quotes) FAILED BUSY ANSWERED CONGESTION UNKNOWN | 230317 |
cdr_limit | int | 100 | Limit on number of saves Format: range 100-5000 Note: small devices try not to exceed 1000 or they may crash (500KB) 5000 entries (2MB) | 230317 |
action | int | 0 | Action execution format: 0 no action, 1 clear CDR data | 230317 |
Server→Client Response
7.2.8 CDR Get /general_option/cdr_get
Client→Server Request
Server→Client Response
DATA_SUBKEY | VAL | Default | Remark |
---|---|---|---|
Refer to /general_option/cdr_set description |