ARS - Route Settings / Route Template
General
Use the [General] section to enable or disable either an ARS template or any of the settings required by Brekeke PBX features, such as [Tenant] in MT Edition if you want to restrict route usage to a certain tenant, the [LineKey] and [Resource] fields for Shared Call Appearance, the [Group] field for ARS group, the [External] field for call logs database and for billing and so on.
| Name | Default value | Description |
| Route name | Name of the route. | |
| Description | Description of the route. | |
| Template | Define if this route is a template (Brekeke PBX v3.1.x or later). | |
| Disabled | checked | Disable / Enable the ARS route. |
| Type | Type A | Used for special functions. |
| Group | ID for a group of ARS routes. | |
| External | unchecked | When checked, Brekeke PBX will recognize this ARS route as an external line. |
| LineKey | unchecked | Check if you use Line keys (optional feature). |
| Session interval (ms) | Set the interval period between sessions for any VoIP FXO Gateways that require pausing between sessions. | |
| Apply this route for incoming calls | Yes | This setting takes effect when there is a registration setup in the route.
If set to yes, the incoming calls will apply this ARS route only when the INVITE request URL is the same as the one in the contact header of the REGISTER request sent by this route. |
| Resource | Set the resource name for users with the SCA feature enabled (optional feature, Brekeke PBX v3.1.x or later). | |
| Tenant (MT Edition) | Set a tenant name. |
Registration
Register your VoIP gateway port SIP number at Brekeke PBX bundled SIP Server. Brekeke PBX will accept calls from this gateway even if the gateway is not registered at Brekeke PBX bundled SIP Server.
If a provider needs authentication information from a caller who makes outbound calls from UAs to an ITSP, Brekeke PBX will send the username and password that are set in this section to the provider in an IP address or in the domain set in the [Proxy Address] field.
| Name | Default value | Description |
| Register URI | SIP URI that is used to register Brekeke PBX at a remote registrar server. Leave this blank when there is no need to register Brekeke PBX to any remote registrar server. | |
| Proxy address | IP address of the registrar server. This field is optional when the proxy address is the same as the address set in the Register URI field. | |
| Register expire (sec) | 3600 | Set when REGISTER expires. |
| Register update period (%) | 90 | The percentage value of the interval until re-register occurs, calculated from the length specified in the register expire setting above. |
| User | User ID for authentication account required by remote registrar server. Entry is not necessary when authentication is not used. | |
| Password | Password for authentication account required by remote registrar server. Entry is not necessary when authentication is not used. |
Patterns
Define Patterns IN and OUT to receive and send calls from/to SIP devices and services.
- Pattern – IN
| Name | Default value | Description | |
| Priority | 100 | Lower numbers hold a higher priority.
It is useful to set priorities when there are multiple options for making calls, such as when you have multiple PSTN gateways for outbound calls or when you subscribe to multiple VoIP service providers. |
|
| Max sessions *1 | -1 | Specify the number of sessions (including RINGING and BYE sessions) that can be handled by each pattern, such as when there is a limited number of Gateway channels or subscribed lines for your SIP services. Setting this field to “-1” specifies an unlimited number of sessions. | |
| Disabled | unchecked | Enable / Disable this pattern. | |
| Matching patterns | From | Specify a matching rule for the From header using regular expressions. When the field is left blank, all calls will be considered as matched. | |
| To | Specify a matching rule for the To header using regular expressions. When the field is left blank, all calls will be considered as matched. | ||
| Plugin | Java class name for the plug-in. | ||
| Param | Parameters that will be used by the plug-in. | ||
| Return | Pattern of the value returned by the plug-in. | ||
| Apply to Request URI instead of To | unchecked | If checked, compares the Request URI instead of the To header; mostly designed for using ITSP accounts. | |
| Apply only to calls related to registration | unchecked | If checked, the route only applies to the calls related to registration. | |
| Deploy patterns | From | Specify replace patterns for the From header using regular expressions. | |
| To | Specify replace patterns for the To header using regular expressions. | ||
| Custom | Used for special functions. | ||
| Parameters | RTP relay | default | Select RTP relay ON / OFF.
If default is selected, the setting will be the same as [Options] > [RTP relay] (unless specified at the User settings). on – RTP is handled by PBX. off – RTP is not handled by PBX. |
| SRTP | default | If default is selected, the setting will be the same as [Options] > [SRTP] (unless specified at the User settings).
off – SRTP is not handled by PBX. optional – Brekeke PBX will handle both RTP and SRTP call; available with [RTP relay] on mandatory – only SRTP call will be handled by Brekeke PBX; available with [RTP relay] on |
|
| Codec priority | Specify codec to be used. Use a comma (,) when specifying multiple payloads. The following payload types may be used with Brekeke PBX:
0 – G.711 u-law 8 – G.711 A-law 18 – G.729 98 – iLBC From Brekeke PBX v3.3.x, Brekeke PBX supports dynamic payload type of iLBC even only payload 98 can be set for iLBC from Brekeke PBX Admintool [Codec priority] field. |
||
| Use remote preferred codec | default | Enable (on) / Disable (off) for using the remote codec used by the endpoints.
When set to default, the remote codec in the [Options] setting will be applied. |
|
| Block SIP INFO (DTMF) | no | Block or pass-through the SIP INFO (DTMF) from a user to the other party. | |
| Send RTCP | off | off – PBX will not handle RTCP packets.
on – PBX will handle RTCP packets. |
|
- Patterns – OUT
| Name | Default value | Description | |
| Priority | 100 | Lower numbers hold a higher priority. | |
| Max sessions *1 | -1 | Specify the number of sessions (including RINGING and BYE sessions) that are allocated to the priority. | |
| Disabled | unchecked | Enable / Disable this pattern. | |
| Matching patterns | From | Specify a matching rule for the From header using regular expressions. When the field is left blank, all calls will be considered as matched. | |
| To | Specify a matching rule for the To header using regular expressions. When the field is left blank, all calls will be considered as matched. | ||
| User | ^.+$ | Mostly designed for multiple ITSP accounts, it specifies the users to which this ARS Route applies. | |
| Class | Specifies the users in the class to which this ARS Route applies. | ||
| Plugin | Java class name for the plug-in. | ||
| Param | The parameters which will be used by the plug-in. | ||
| Return | The pattern of the value returned by the plug-in. | ||
| Deploy patterns | From | Specify replace patterns for the From header using regular expressions. | |
| To | Specify replace patterns for the To header using regular expressions. | ||
| Target | Destination IP address. May omit entry when the destination IP address is specified in the To header domain. | ||
| Whisper/DTMF | When DTMF needs to be issued after calling a gateway (two-stage calling), you can specify the DTMF string using some part of the [To] matching pattern.
Whisper: Example of whisper syntax: |
||
| Confirm | Define the voice prompt used with a confirm call. | ||
| Key | 5 | Define the confirm key entry. | |
| Custom | Used for special functions. | ||
| Parameters
|
RTP relay | default | Select RTP relay ON / OFF.
If default is selected, this value is the same as in [Option] menu > [RTP relay] (unless specified at the User settings). on – RTP is handled by Brekeke PBX. off – RTP is not handled by Brekeke PBX. |
| SRTP | default | If default is selected, the setting will be the same as [Options] > [SRTP] (unless specified at the User settings).
off – SRTP is not handled by PBX. optional – Brekeke PBX hande both RTP and SRTP call; available with [RTP relay] on mandatory – only SRTP call will be handled by Brekeke PBX; available with [RTP relay] on |
|
| Codec priority | Specify codec to be used. Use a comma (,) when specifying multiple codecs. | ||
| Block SIP INFO (DTMF) | no | Stop (or not) passing DTMF from a user to the other party when Brekeke PBX receives DTMF. | |
| Send RTCP | off | off – Brekeke PBX will not handle RTCP packets.
on – Brekeke PBX will handle RTCP packets. |
|
| Session timer(sec, 0=disable) | 0 | Interval to allow both UAs and SIP server to determine whether the SIP session is still active. | |
| 100rel | off | Enable (on) / Disable (off) using reliable provisional responses (1xx series). | |
| Video | default | If default is selected, the setting will be the same as [Options] > [Video] (unless specified at the User settings).
on – video call is handled by PBX off – video is not handled by PBX. |
|
| Next route on failure | no | Set failover for outbound sessions (or not). | |
| Disable on registration failure | no | Enable (yes) / Disable (no) this Pattern when registration fails. | |
| Response timeout (ms) | -1 | Period of time when a response has not been received before timeout is activated. | |
| Error codes | 500 | Failover will be activated when specified error codes are received for INVITE requests. | |
| Recovery time (ms) | 0 | Period of time until this pattern will be reactivated. | |
| Disable on failure | This route | Disable this route when using this OUT pattern fails. Can also be set to disable one pattern in the ARS route or multiple ARS routes with the same group ID.
Options: This route, This pattern, This group |
|
*1. For ARS routes in the same group, there is only one session counter. The session counter for the group will increase by one when there is a call through any ARS route in this group, regardless of what is specified in Pattern IN or OUT. If this session counter is equal to any pattern [Max Sessions] value that is set in the same group’s ARS routes, the next matched session cannot apply to this pattern (IN or OUT) or to any ARS routes when all of the patterns’ [Max Sessions] for the ARS routes in the same group are set to the same value.
Related Links: