background image

                                       

                                                  Analog Gateway User Manual

 

    49 

OpenVox Communication Co. ,LTD.

                                                                                                                   

URL: www.openvox.cn

 

 

 

7. Advanced 

Asterisk API 

When you make “Enable” switch to “on”, this page is available.   

Figure 7-1-1 API Interface 

 

 

Table 7-1-1 Definition of Asterisk API 

Options   

Definition 

Port 

Network port number 

Manager Name 

Name of the manager without space 

Manager secret 

Password for the manager. 

Characters: Allowed characters “-_+.<>&0-9a-zA-Z”.   

Length:4-32 characters. 

Deny 

If  you  want  to  deny  many  hosts  or  networks,  use  char  &

  as  separator.Example:  0.0.0.0/0.0.0.0  or  192.168.1.0/255.2

55.255.0&10.0.0.0/255.0.0.0 

Summary of Contents for Analog Gateway Series

Page 1: ...Analog Gateway User Manual 1 OpenVox Communication Co LTD URL www openvox cn OpenVox Communication Co Ltd Analog Gateway User Manual Version 1 0 ...

Page 2: ...g 6 A Baoneng Science and Technology Industrial Park Longhua New District Shenzhen Guangdong China 518109 Tel 86 755 66630978 82535461 82535362 Business Contact sales openvox cn Technical Support support openvox cn Business Hours 09 00 18 00 GMT 8 from Monday to Friday URL www openvox cn Thank You for Choosing OpenVox Products ...

Page 3: ...x Inc reserves the right to modify the design characteristics and products at any time without notification or obligation and shall not be held liable for any error or damage of any kind resulting from the use of this document OpenVox has made every effort to ensure that the information contained in this document is accurate and complete however the contents of this document are subject to revisio...

Page 4: ...Analog Gateway User Manual 4 OpenVox Communication Co LTD URL www openvox cn Revise History Version Release Date Description 1 0 22 12 2017 First Version ...

Page 5: ...es 9 Physical Information 10 Software 10 2 System 12 Status 12 Time 12 Login Settings 13 General 15 Language Settings 15 Scheduled Reboot 15 Tools 15 Information 17 3 Analog 18 Channel Settings 18 Pickup Settings 19 Dial Matching Table 20 Advanced Settings 20 Special Function Keys 24 4 SIP 25 SIP Endpoints 25 Main Endpoint Settings 25 Advanced Registration Options 27 Call Settings 28 ...

Page 6: ...32 Advanced SIP Settings 32 Networking 32 NAT Settings 33 RTP Settings 34 Parsing and Compatibility 34 Security 35 Media 36 Sip Account Security 37 5 Routing 38 Call Routing Rules 38 Groups 41 Batch Create Rules 42 6 Network 44 Network Settings 44 VPN Settings 46 DDNS Settings 46 Toolkit 47 7 Advanced 49 Asterisk API 49 Asterisk CLI 51 Asterisk File Editor 52 8 Logs 53 Log Settings 53 System 55 ...

Page 7: ...Analog Gateway User Manual 7 OpenVox Communication Co LTD URL www openvox cn CDR 55 ...

Page 8: ...rough AMI Asterisk Management Interface The Modular Design Analog Gateway Series are developed for interconnecting the PSTN networks with a wide selection of codecs and signaling protocol including G 711A G 711U G 729 G 722 G 723 ILBC to quickly reduce communication expenses and maximize cost savings The Analog Gateway Series use standard SIP protocol and compatible with Leading IMS NGN platform I...

Page 9: ...vox cn Product Appearance The picture below is appearance of Analog Series Gateway Figure 1 3 1 Product Appearance Figure 1 3 2 Front Panel 1 Reset button 2 Power Indicator 3 System LED 4 Analog Telephone Interface 2 5 Channels State Indicator Main Features Modular design ...

Page 10: ...ling protocol DTMF relay Ring cadence and frequency setting MWI Message waiting indicator DHCP DNS DDNS NAT Network VAG and CNG All hot swap Stable performance flexible dialing friendly GUI Two year time warranty Physical Information Table 1 5 1 Description of Physical Information Weight 200g Size 22cm 2cm 12cm Temperature 40 125 C Storage 0 50 C Operation Operation humidity 10 90 non condensing P...

Page 11: ... in your browser to scan and configure the module you want Now we offer you two RJ45 Network ports to access to your gateway on the board ETH1 and ETH2 ETH1 only can enter the ip of slot 1 and ETH2 can access every slot You can choose either of them that depends on your demand Figure 1 6 1 Login Interface ...

Page 12: ...atus On the Status page you will see Port SIP Routing Network information and status Figure 2 1 1 System Status Time Table 2 2 1 Description of Time Settings Options Definition System Time Your gateway system time Time Zone The world time zone Please select the one which is the same or the ...

Page 13: ...ther enable automatically synchronize from NTP server or not ON is enable OFF is disable this function Sync from NTP Sync time from NTP server Sync from Client Sync time from local machine For example you can configure like this Figure 2 2 1 Time Settings You can set your gateway time Sync from NTP or Sync from Client by pressing different buttons Login Settings Your gateway doesn t have administr...

Page 14: ...our username and password to manage your gateway without space here Allowed characters _ 0 9a zA Z Length 1 32 characters Password Allowed characters _ 0 9a zA Z Length 4 32 characters Confirm Password Please input the same password as Password above Login Mode Select the mode of login HTTP Port Specify the web server port number HTTPS Port Specify the web server port number Port SSH login port nu...

Page 15: ...guage you need Then upload your modified packages Choose File and Add those will be ok Figure 2 4 1 Language Settings Scheduled Reboot If switch it on you can manage your gateway to reboot automatically as you like There are four reboot types for you to choose By Day By Week By Month and By Running Time Figure 2 4 2 Reboot Types If use your system frequently you can set this enable it can helps sy...

Page 16: ... two kinds of update types for you you can choose System Update or System Online Update System Online Update is an easier way to update your system Figure 2 5 2 Update Firmware If you want to store your previous configuration you can first backup configuration then you can upload configuration directly That will be very convenient for you Notice the version of backup and current firmware should be...

Page 17: ...on Co LTD URL www openvox cn Information On the Information page there shows some basic information about the analog gateway You can see software and hardware version storage usage memory usage and some help information Figure 2 6 1 System Information ...

Page 18: ...LTD URL www openvox cn 3 Analog You can see much information about your ports on this page Channel Settings Figure 3 1 1 Channel System On this page you can see every port status and click action button to configure the port Figure 3 1 2 FXO Port Configure ...

Page 19: ...ed in a telephone system that allows one to answer someone else s telephone call You can set the Time Out and Number parameters either globally or separately for each port The feature is accessed by pressing a special sequence of numbers which you set as Number parameter on the telephone set when it is enabled this function Figure 3 2 1 Pickup Configure ...

Page 20: ... timeout in milliseconds ms Note You can only enter numbers Number Pickup number Dial Matching Table Dialing rules is used to effectively judge whether the received number sequence is complete in order to timely end receiving number and send out number The correct use of dial up rules helps to shorten the turn on time of phone call Figure 3 3 1 Port Configure Advanced Settings ...

Page 21: ...seconds Dial timeout Specifies the number of seconds we attempt to dial the specified devices Codec Set the global encoding mulaw alaw Impedance Configuration for impedance Echo cancel tap length Hardware echo canceler tap length VAD CNG Turn on off VAD CNG Flash Wink Turn on off Flash wink Max flash time Max flash time in milliseconds as Ending Dial Key Turn on off Ending Dial Key Checking SIP St...

Page 22: ...erent ring tones ring ring which means the caller ID needs to be set later on and not just after the first ring as per the default 1 Waiting time before sending CID How long we will waiting before sending the CID on the channel in milliseconds Sending polarity reversal DTMF Only Send polarity reversal before sending the CID on the channel Start code DTMF Only Start code Stop code DTMF Only Stop co...

Page 23: ...gain Range from 150 to 120 Select 35 0 or 35 FXS Tx gain Set the FXS port Tx gain Range from 150 to 120 Select 35 0 or 35 Figure 3 4 4 Fax Configuration Table 3 4 4 Definition of Fax Options Definition Mode Set the transmission mode Rate Set the rate of sending and receiving Ecm Enable disable T 30 ECM error correction mode by default Figure 3 4 5 Country Configuration ...

Page 24: ... played when the receiving end is ringing Busy tone Set of tones played when the receiving end is busy Call waiting tone Set of tones played when there is a call waiting in the background Congestion tone Set of tones played when there is some congestion Dial recall tone Many phone systems play a recall dial tone after hook flash Record tone Set of tones played when call recording is in progress In...

Page 25: ...o modify existed endpoints you can click button Main Endpoint Settings There are 3 kinds of registration types for choose You can choose Anonymous Endpoint registers with this gateway or This gateway registers with the endpoint You can configure as follows If you set up a SIP endpoint by registration None to a server then you can t register other SIP endpoints to this server If you add other SIP e...

Page 26: ...nvenience we have designed a method that you can register your SIP endpoint to your gateway thus your gateway just work as a server Figure 4 1 3 Register to Gateway Also you can choose registration by This gateway registers with the endpoint it s the same with None except name and password Figure 4 1 4 Register to Server ...

Page 27: ...ould be register to a SIP server Hostname or IP Address IP address or hostname of the endpoint or dynamic if the endpoint has a dynamic IP address This will require registration Transport This sets the possible transport types for outgoing Order of usage when the respective transport protocols are enabled is UDP TCP TLS The first enabled transport type is only used for outbound messages until a Re...

Page 28: ... The port number the gateway will connect to at this endpoint Quality Whether or not to check the endpoint s connection status Qualify Frequency How often in seconds to check the endpoint s connection status Outbound Proxy A proxy to which the gateway will send all outbound signaling instead of sending signaling directly to endpoints Custom Registery Custom Registery On Off Enable Outboundproxy to...

Page 29: ...ringing Always use never to never use in band signaling even in cases where some buggy devices might not render it Valid values yes no never Default never Allow Overlap Dialing Allow Overlap Dialing Whether or not to allow overlap dialing Disabled by default Append user phone to URI Whether or not to add user phone to URIs that contain a valid phone number Add Q 850 Reason Headers Whether or not t...

Page 30: ...vention Send TRYING on REGISTER Send a 100 Trying when the endpoint registers Advanced Timer Settings Table 4 1 5 Definition of Timer Options Options Definition Default T1 Timer This timer is used primarily in INVITE transactions The default for Timer T1 is 500ms or the measured run trip time between the gateway and the device if you have qualify yes for the device Call Setup Timer If a provisiona...

Page 31: ... or uas Defaults to uas Media Settings Table 4 1 6 Definition of Media Settings Options Definition Media Settings Select codec from the drop down list Codecs should be different for each Codec Priority FXS Batch Binding SIP If you want binding batch Sip accounts to FXS port you can configure this page Look out this is only used when This gateway registers with the endpoint work mode Figure 4 2 1 F...

Page 32: ... which to listen for TCP traffic TCP Authentication Timeout The maximum number of seconds a client has to authenticate If the client does not authenticate before this timeout expires the client will be disconnected default value is 30 seconds TCP Authentication Limit The maximum number of unauthenticated sessions that will be allowed to connect at any given time default is 50 Enable Hostname Looku...

Page 33: ...n_sip will renew all outbound registrations when the monitor detects any sort of network change has occurred By default this option is enabled but only takes effect once res_stun_monitor is configured If res_stun_monitor is enabled and you wish to not generate all outbound registrations on a network change use the option below to disable this feature Match External Address Locally Only substitute ...

Page 34: ... server resolution fails RTP Settings Table 4 4 3 Definition of NAT Settings Options Options Definition Start of RTP Port Range Start of range of port numbers to be used for RTP End of RTP port Range End of range of port numbers to be used for RTP RTP Timeout Parsing and Compatibility Table 4 4 4 Instruction of Parsing and Compatibility Options Definition Strict RFC Interpretation Check header tag...

Page 35: ...iry Minimum length of registrations subscriptions default 60 Default Registration Expiry Default length of incoming outgoing registration Registration Timeout How often in seconds to retry registration calls Default 20 seconds Number of Registration Attempts Enter 0 for unlimited Number of registration attempts before we give up 0 continue forever hammering the other server until it accepts the re...

Page 36: ...bling this option will authenticate OPTIONS requests just like INVITE requests are By default this option is disabled Allow Guest Calling Allow or reject guest calls default is yes to allow If your gateway is connected to the Internet and you allow guest calls you want to check which services you offer everyone out there by enabling them in the default context Media Table 4 4 6 Instruction of Medi...

Page 37: ...it can worked as TLS server generate the session keys used for the secure connection On the other hand it also can be registered as a client upload the key files provied by the server Figure 4 5 1 TLS settings Table 4 5 1 Instruction of TLS Options Definition TLS Enable Enable or disable DTLS SRTP support TLS Verify Server Enable or disable tls verify server default is no Port Specify the port for...

Page 38: ...lly click the button to save what you set will show current routing rules Otherwise you can set up unlimited routing rules There is an example for routing rules number conversion it transform calling called number at the same time Suppose you want eleven numbers start at 159 to call the eleven numbers of start at 136 Calling transform delete the three numbers from left then writing number 086 as p...

Page 39: ...n Call Comes in From is 1001 prepend prefix and match pattern in Advanced Routing Rule are ineffective and just CallerID option is available Table 5 1 2 Definition of Call Routing Rule Options Definition Routing Name The name of this route Should be used to describe what types of calls this route matches for example SIP2GSM or GSM2SIP Call Comes in From The launching point of incoming calls Send C...

Page 40: ... prepended before sending to the trunks Prefix Prefix to remove on a successful match The dialed number is compared to this and the subsequent columns for a match Upon a match this prefix is removed from the dialed number before sending it to the trunks Mach Pattern The dialed number will be compared against the prefix this match pattern Upon a match the match pattern portion of the dialed number ...

Page 41: ...l Failover Call Through Number The gateway will attempt to send the call out each of these in the order you specify Groups Sometimes you want to make a call through one port but you don t know if it is available so you have to check which port is free That would be troublesome But with our product you don t need to worry about it You can combine many Ports or SIP to groups Then if you want to make...

Page 42: ...oups Options Definition Group Name The mean of this route Should be used to describe what types of calls this route match for example sip1 TO port1 or port1 To sip2 Batch Create Rules If you bind telephone for each FXO port and want to establish separate call routings for them For convenience you can batch create call routing rules for each FXO port at once in this page ...

Page 43: ...Analog Gateway User Manual 43 OpenVox Communication Co LTD URL www openvox cn Figure 5 3 1 Batch Create Rules ...

Page 44: ...f LAN port IP Factory Static and DHCP Factory is the default type and it is 172 16 99 1 When you Choose LAN IPv4 type is Factory this page is not editable A reserved IP address to access in case your gateway IP is not available Remember to set a similar network segment with the following address of your local PC Figure 6 1 1 LAN Settings Interface Table 6 1 1 Definition of Network Settings Options...

Page 45: ...teway Netmask The subnet mask of your gateway Default Gateway Default getaway IP address Reserved Access IP A reserved IP address to access in case your gateway IP is not available Remember to set a similar network segment with the following address of your local PC Enable A switch to enable the reserved IP address or not ON enabled OFF disabled Reserved Address The reserved IP address for this ga...

Page 46: ...is info is from your local network service provider VPN Settings You can upload the VPN client configuration if success you can see a VPN virtual network card on SYSTEM status page About the configure format you can refer to the Notice and Sample configuration Figure 6 2 1 VPN Interface DDNS Settings You can enable or disable DDNS dynamic domain name server Figure 6 3 1 DDNS Interface ...

Page 47: ... DDNS dynamic domain name server Type Set the type of DDNS server Username Your DDNS account s login name Password Your DDNS account s password Your domain The domain to which your web server will belong Toolkit It is used to check network connectivity Support Ping command on web GUI Figure 6 4 1 Network Connectivity Checking Figure 6 4 2 Channel Recording ...

Page 48: ...Definition Interface The name of network interface Source host Capture the data of source host you specified Destination host Capture the data of destination host you specified Port Capture the data of port you specified Channel Capture the data of channel you specified Tcpdump Option Parameter The tool of tcpdump capture network data by parameter option specified ...

Page 49: ...face Table 7 1 1 Definition of Asterisk API Options Definition Port Network port number Manager Name Name of the manager without space Manager secret Password for the manager Characters Allowed characters _ 0 9a zA Z Length 4 32 characters Deny If you want to deny many hosts or networks use char as separator Example 0 0 0 0 0 0 0 0 or 192 168 1 0 255 2 55 255 0 10 0 0 0 255 0 0 0 ...

Page 50: ... used Command Permission to run CLI commands Write only Agent Information about queues and agents and ability to add queue members to a queue User Permission to send and receive UserEvent Config Ability to read and write configuration files DTMF Receive DTMF events Read only Reporting Ability to get information about the system CDR Output of cdr manager if loaded Read only Dialplan Receive NewExte...

Page 51: ...vox cn Figure 7 1 2 Putty Access Asterisk CLI In this page you are allowed to run Asterisk commands Figure 7 2 1 Asterisk Command Interface Table 7 2 1 Definition of Asterisk API Options Definition Command Type your Asterisk CLI commands here to check or debug your gateway ...

Page 52: ...it the page will show you the executable commands Asterisk File Editor On this page you are allowed to edit and create configuration files Click the file to edit Figure 7 3 1 Configuration Files List Click New Configuration File to create a new configuration file After editing or creating please reload Asterisk ...

Page 53: ...ings On the Log Settings page you should set the related logs on to scan the responding logs page For example set System Logs on like the following then you can turn to System page for system logs otherwise system logs is unavailable And the same with other log pages Figure 8 1 1 Logs Settings ...

Page 54: ...le DTMF info switch Auto clean asterisk logs switch on when the size of log file reaches the max size the system will cut a half of the file New logs will be retained switch off logs will remain and the file size will increase gradually default on max size 100KB SIP Logs Whether enable or disable SIP log Auto clean SIP logs switch on when the size of log file reaches the max size the system will c...

Page 55: ... URL www openvox cn System Figure 8 2 1 System Logs Output Notice The same to Asterisk Logs and SIP Logs CDR You can scan every call detail records in this page We also provide the filter for you to search some specific records Figure 8 3 1 Call Detail Record ...

Reviews: