FR EN

25. Settings

Estimated reading: 137 minutes

The settings are used to define the global system variables. These settings are applied to the entire system if they are not specified at a lower level.

For example: ” Settings: Voicemail: Send attachment’=’Yes’ will set ‘Set attachment’ for all local and remote extensions. But each extension can override this rule by setting the option “Extensions: Edit: Advanced Options: Attach’=’No’

Servers

PBXware system administration allows you to manage an unlimited number of servers from a single administration interface. The system's servers can operate in the following modes:

  • Server name:
    Unique and custom server name on the network.
  • PBXware address :
    IP address on which the PBXware daemon runs. Since the PBXware daemon will always run on the same server, this IP address cannot be changed and is always 127.0.0.1.
  • Edits the server configuration.
  • Deletes a server from the system.

Edit the server

Network info

  • Server name:

    Enter the custom server name (sometimes used in system notifications).

  • PBXware address :

    Enter the IP address on which the PBXware daemon runs. Since the PBXware daemon will always run on the same server, this IP address cannot be changed and it is always ‘127.0.0.1’.

  • Use DNS resolution for Communicator

    Select whether or not Communicator will use DNS SRV lookup.

  • Communicator SIP proxy address (:port):

    Enter the public IP address/domain of the Communicator SIP Proxy.

  • QR Code server:
    Enter the public address of PBXware
  • Domain name:
    Enter the fully qualified domain name of this server

Auto Provisioning

Auto Provisioning sets the values to use for the auto provisioning system in order to create auto provisioning files correctly based on the UAD location (local/remote).

  • HTTP Username

    Username for HTTP auto-provisioning. Required to authenticate auto-provisioning requests with the PBXware server.

  • HTTP password

    Password for HTTP auto provisioning. Required to authenticate auto provisioning requests with the PBXware server.

  • LAN Hostname/IP:

    LAN IP address used for auto-provisioning of local UADs.

  • WAN Hostname/IP:

    WAN IP address used for auto-provisioning of remote UADs.

  • Max number of requests:

    The value represents the maximum number of auto-provisioning requests accepted by PBXware in a one-minute period.
    If the number of requests is greater than the defined number, the IP address of the provisioning request will be blocked for a period of 5 minutes.
    The user will still be able to access the PBXware GUI.

  • Communicator LAN server:

    PBXware LAN IP address that users connecting to PBXware from the LAN will use to register their Communicator clients.

  • Communicator WAN server:

    PBXware WAN IP address that users connecting to PBXware from the WAN will use to register their Communicator clients.

  • TLS client certificate validation

Enable TLS client certificate validation

  • Enable TFTP:
    The TFTP service is disabled by default. To enable it, set this option to Yes, then start the service manually from the Services page.
  • Use DNS server if possible:
    Whether the phones should use the DNS SRV records to find the SIP port of the DNS server, if the phone supports it.
  • WAN host for DNS SRV:
    WAN IP address/domain for the DNS SRV host.

Email

During its operation, the system sends notifications and alerts by email to various users and administrators. These emails can be sent using a built-in “local mail server” or a remote SMTP server.

  • From the email address:
    Allows you to set the From: field in Email.

Locality

The locality defines where the system operates.

  • Country:

    Country from which the server operates.

  • DAHDI zone:

    Overrides automatic country detection
    It is recommended to keep this setting on "Automatic".

  • Indications:

    Which indications (ringing, busy, etc.) should be used by PBXware?

  • Phone code:

    Area code in which the system is located or from which it operates.
    (For example, if the system is located in New York, indicate the New York area code (212) here).

  • National dialing code:

    Code required to dial national destinations.

  • Leave National Code:

    In some countries, the national code is automatically removed. If this setting is set to "Yes", the national code will not be removed from the dialed number.

  • International dialing code:

    Code required to dial international destinations.

  • International dialing code:

    Code required to dial international destinations.

  • Currency symbol / ISO code:

    Symbol of the currency of the country where the server is located.

  • Currency formatting template:
    • Symbol before amount – The currency symbol will be displayed before the amount.
    • Symbol after the amount – The currency symbol will be displayed after the amount.
  • Minimum length of the dialed number:
    Set the minimum number of digits dialed for a call to leave the system.

Emergency services

By clicking on the “Emergency services” button, a pop-up window appears in which users can enter the emergency numbers for the police, fire department, and ambulance.

  • Email notification:
    After dialing one of the emergency numbers, an email will be sent to the address specified in this field. Users can enter one or more email addresses according to their preferences and needs.
    If several addresses are added, they can be separated by a new line or a semicolon ';'.

The box is resizable, which makes it more convenient to use.

For more information, please refer to the screenshots.

Default dialing

The default dialing is defined during the initial system setup to determine the number of digits the system will use by default. You can select a value between 2 and 16.

  • Extension digit length:

    Number of digits used by the system to create local extensions, IVRs, queues, voicemail boxes, conferences, etc. This option is only available during the setup wizard installation procedure. To change the number of digits after the setup wizard has been installed, you will need to delete all extensions, ring groups, DIDs, conferences, IVRs and voicemail boxes. The recommended value for this field is 4.

  • Extension alias prefix:

    Digit preceding the dialed number on systems that switched from 3 to 4 digits, for example.
    (For example, if your old system used 3 digits and you want to switch to 4 digits, set '1' here to assign '1' as a prefix to all extensions on the system. In this way, the old extension 300 becomes 1300).

  • Extension alias length:
    Length of the old numbering system.
  • PSTN dialing mode:
    If this option is enabled, when a number is dialed, it is not necessary to use the DID; the system automatically calls that extension.

LDAP

If this option is enabled, auto-provisioned phones will receive the contacts of the company directory instead of the system extensions. Currently, this feature only applies to Yealink, Polycom, and Cisco phones. Phones from other manufacturers will ignore this option and use the directory as before.

  • Enable:

    Enables/disables the LDAP corporate directory feature.

  • Password:
    Password sent to phones with the auto provisioning configuration and used to authenticate the phone with PBXware when searching for/retrieving contacts.
  • Include system extensions:
    By default, when LDAP is enabled, phones only serve the contacts defined in the company directory. If this option is set to Yes, the contact list will also include the system's extensions.

STIR/SHAKEN

This will only work for calls originating from Trunks.

  • PAI header parameter name

    Set this field to the desired value.

  • Pass the PAI header to the UAD
    Set this option to “Yes” so that Polycom phones perform STIR/SHAKEN caller ID validation.
  • Enable call filtering

    Enable PBXware’s STIR/SHAKEN call filtering.

  • Abandon calls with verification status
    Select the verification status for which calls will be dropped

Additional information:

Example: "P-Asserted-Identity: <sip:+1234567890;verstat=TN-Validation-Passed@xx.xxx.x.xxx:xxxx>
P-Attestation-Indicator: B”

Please note that the additional header check is added for STIR/SHAKEN. P-Asserted-Identity” can have one of the following values: ‘TN-Validation-Passed’, ‘TN-Validation-Failed’ or “No-TN-Validation”: ‘TN-Validation-Passed’, ‘TN-Validation-Failed’, or ‘No-TN-Validation’, while the level can be seen in a new header, for example: ‘P-Attestation-Indicator: B’.

If a user selects 'TN-Validation-Failed-B' and 'No-TN-Validation' as values for 'Drop calls with verification status', the call will be dropped because it matches 'TN-Validation-Passed' plus 'B'.

However, if no flag is provided, an exact match between the verstat value of the PAI header and the value specified in the “Reject calls with verification status” field is expected: “P-Asserted-Identity: <sip:+1234567890;verstat=TN-Validation-Passed-B@xx.xxx.x.xxx:xxxx>”.

STIR/SHAKEN is a framework that helps reduce fraudulent calls and the illegal spoofing of phone numbers. STIR/SHAKEN is implemented in PBXware to comply with the FCC's STIR/SHAKEN rules. PBXware has added its implementation of STIR/SHAKEN which allows signing and validating calls with valid STIR/SHAKEN certificates that customers own.

Please note that we do not provide any certificate.

  • Public certificate
    Download the public certificate.
  • Private key
    Download the private key.

General settings

  • Trunk announcement
    Sets whether or not to announce on which trunk the call is routed
    (For example, John dials ‘55510205’ and this call goes through the system's default secondary trunk. John will hear the following message: “Using secondary trunk to complete your call”).
  • Absolute delay (sec)

    Set the maximum duration in seconds of a call.

  • Voice messages in CDRs

    Define how unanswered calls and those redirected to voicemail are displayed in the CDR.

The options are as follows:

  • Answered calls: When a call is redirected to voicemail, it will appear as "Answered" in the CDR.
  • Unanswered calls: When a call is redirected to voicemail, it will appear as "No Answer" in the CDR.
  • On Voicemail: When a call is redirected to voicemail, it appears as "Voicemail" in the CDR.
  • Fax page format

    Select the page format when downloading a fax in PDF format.

The options are as follows:

    • PDF and TIFF
    • PDF only
    • TIFF only
  • Routing mode

    Select the type of routing mode that will be used for the Routes

The options are as follows:

    • E.164 route: Sets the routing mode where routes are defined using E.164 dialing rules.
    • Simple route: Sets the routing mode in which users manually define routes based on their needs.
  • RPS provisioning credentials expiration (6.6.1)

    Set a time period in hours or days after which the RPS provisioning credentials will expire.
    (For example, if the user sets the RPS provisioning credentials expiration to "1 hour", it means that after sending the registration request, the user has one hour to reset the device to factory settings and resume the configuration).

  • Default extension location

    Indicate whether the default location of the extension is “remote” or “local”. Once selected, it applies to the entire system when creating new extensions.

  • Show advanced options by default

    Indicate whether the “advanced options” should be displayed by default.
    (For example, if the parameter is set to Yes, all pages that have advanced options will display them automatically, without the need to click the button on each page).

  • Default domain of the online supervisor

    Set the default domain used for connecting to the Online Supervisor Console (OSC).
    (for example, http://pbx.domain.com/)

  • Find E.164 numbers in DIDs

    Enable or disable E.164 matching of numbers as defined in the E.164 fields of the DIDs.

  • Number of objects per page (default: 10):

    Sets the number of objects displayed per page
    (For example, if a user sets this value to "20", they will see at most 20 extensions on the Extensions page, 20 CDR entries on a page, and so on).

  • Number of objects displayed in the statistics breakdown

    Set the number of items that will be displayed in the statistics breakdown [IVR Statistics]
    (For example, if users set this value to "50", this number of objects will be displayed in the statistics breakdown).

  • Show the directory in the online supervisor:
    Indicate whether the directory should be displayed in the online supervisor (OSC).
    (For example, the extensions visible in the directory are those for which the “Show in directory” option is set to Yes).
  • Emergency trunks per extension:
    If the “Show Directory in Online Supervisor” option is set to Yes, users will see a new group called “Emergency Trunks” on the Extensions page. These trunks will replace the trunks defined on the Trunks page.
  • SIP response for nonexistent DIDs
    Select the SIP response that will be sent to a provider if the called DID does not exist on the system.

The following options are offered:

  • By default
  • 403 – Call rejected
  • 404 – Not Found
  • 408 – Request Timeout
  • 410 – Gone
  • 480 – Temporarily Unavailable
  • 484 – Address Incomplete
  • 486 – Busy Here
  • 488 – Not Acceptable Here
  • 500 – Internal Server Error
  • 501 – Not Implemented
  • 502 – Bad Gateway
  • 503 – Not Implemented
  • Emergency location header

    Set an emergency location header.

For more information, please refer to this TUTORIAL.

  • Device location ID
    Set the location ID of a device supplied by trunk providers by provisioning the E911 endpoint. The E911 endpoint provisioning process is different for each provider.
  • ERG abandoned check interval (min) (6.6.1)
    Enter the check interval in minutes after which the email will be sent to all defined notification emails containing information about abandoned calls.

Uptime

By clicking on this button, you open a page where users can configure the system's operating hours.

See TUTORIAL: Uptime

Call recordings

  • Record all calls by default:
    Set this option to “Yes” to enable call recording at the system level.
  • Default recording silent mode:
    Enable silent recording by default
  • Force recording for emergency calls:
    If this parameter is set to “Yes”, recording will be forced for emergency calls.
  • Silent recording for emergency calls:
    If this parameter is set to “Yes”, emergency call recordings will be silent (no sound, no beep indicating that a call is being recorded).
  • Disable video call recording
    If the setting is set to “Yes”, large and unnecessary files will not be created when a video call leaves a voicemail.

  • Auto MP3 conversion:

    Converts recording files to mp3. This function applies to recordings across the entire system.

    • Convert and delete the original
      Convert all recording files to MP3 and delete the original files.
    • Convert and keep the original
      Convert all files to MP3 and keep the original files.
    • Convert on listen/Download
      Recordings are left in their original format and are only converted to mp3 when they are requested for listening/downloading, which allows both the original version and the mp3 version of the recording to be kept after listening/downloading.
    • Do not convert
      Leaves the files in the original format without conversion. (recordings cannot be played from the graphical interface).
  • Play a periodic Beep (sec):

    Beep interval when recording is not silent. If this field is empty or set to 0, no beep will be emitted.
    (For example, if this field is set to 5, a beep will be emitted every 5 seconds during the recording of a call).

  • Instant email logging interval (min):

    Instant recordings are not emailed immediately after being recorded, but rather periodically. This field allows you to set how often PBXware will send the recordings.

  • Recording format:
    Format used to save system call and voicemail recordings. You will find more details on disk space usage at the end of this chapter.
    Choose one of the following formats: gsm, wav, wav49 or ogg. If wav is selected, all call and voicemail recordings will be saved in wav format).
  • RAM usage:
    To speed up the recording process, you can enable the RAM disk, which records practically all calls in RAM memory before storing them on disk.
  • RAM disk size (1 min ~ 200 KB):
    Amount of memory used for call recording. This value can only be changed if the “RAM usage” option is set to “Yes”.

Administration
This section allows remote administration of the system.

  • Daemon username:

    Username that PBXware uses to connect to the Asterisk Manager.

  • Daemon password:

    Password that PBXware uses to connect to Asterisk Manager. The password is randomly generated during installation and cannot be changed.

  • Port:

    PBXware Daemon connection port.
    (Default value 10001)

  • AGI Port:

    AGI connection port.
    (For example, 4573)

  • Allow LDAP usernames:

    This tells PBXware to accept Communicator registrations when it uses a Windows® username for this.

Location

  • Audio language:
    Sets the language in which the audio files are played.

Enhanced call parking

During a call, the user can dial ‘#800’. The call will be parked and “the announcement extension” will ring for a certain number of seconds.

  • Timeout (s):

    Extension that will receive a call from PBXware and be notified on which parking lot the call is parked. If this extension does not answer the call after a certain time, the call will be directed to the Timeout extension.

  • Announcement extension:
    Extension that will receive a call from PBXware and be notified on which parking lot the call is parked. If this extension does not answer the call after a certain time, the call will be directed to the Timeout extension.
  • Extension timeout:
    Destination to which the call will be directed if the call is not answered after the Parking timeout.

Limit notification for the extensions channel

Here you can define whether there will be a notification when users exceed their outgoing call limits. These options apply to all extensions.

  • Listen to the recording:
    This option tells the system to play a notification sound when an extension exceeds its outbound call limit.
  • Send the email:
    Whether or not to send a notification email when the limit is exceeded.
  • Email notification:
    Email address to which a notification mail should be sent if the number of calls exceeds the limit.

Slices

Depending on the server's processor power, a custom limit can be assigned to the different slice types.

  • Local channels:
    Total number of channels used by local UADs.
  • Remote channels:
    Maximum number of active incoming or outgoing channels for the server.
  • Conferences:
    Total number of conferences in the system.
  • Queues:
    Total number of ACD queues in the system.
  • Auto Attendants:
    Total number of all IVRs in the system.
  • DAHDI:
    Total number of all trunks in the system using the DAHDI protocol.
  • Email to Fax
    Maximum number of simultaneous fax calls via the Email to Fax application.

DIDs missed call notifications

Missed calls on DIDs will be logged and sent as a summary email. Here you can define where this email will be sent, how the call entries will be sorted, and the interval at which the notification is sent.

  • Email notification:

    Recipient of the notification email.

  • Sort by:

    How calls are categorized in the email

    • Date: All entries are presented as a single table sorted by call date.
    • DID: Entries are distributed across multiple tables (one table per DID) and sorted individually by date within each table.
  • Notification frequency (in minutes):
    Indicates how often (in minutes) the notification email will be sent. If no call has been missed during this period, no email is sent. The email is only sent if there has been at least one missed call.

Jitter Buffer

  • Jitter Buffer:
    • Inherit
      Inherits the Jitter Buffer settings from the tenant configuration.
    • Fixed
      Sets a fixed Jitter Buffer on the channel.
    • Adaptive
      Sets an adaptive Jitter Buffer on the channel.
    • Disabled
      Deletes a Jitter Buffer previously set on the channel.
  • Max length (ms):

    Buffer length in milliseconds. By default, it is 200 ms.

  • Re-synchronization threshold:

    Duration in milliseconds beyond which a timestamp difference will trigger a resynchronization of the Jitter Buffer. The default value is 1000 ms.

  • Extra target:

    This parameter only affects the adaptive Jitter Buffer. It represents the time in milliseconds by which the size of the new Jitter Buffer will be increased. The default value is 40.

Default codecs

Default codecs can be set for the following groups:

  • Local
    Local extensions.
  • Remote
    Extensions and trunks.
  • Network
    PBXware network (two or more servers).
  • G.711 alaw – 64 Kbps, sample-based, used in Europe
  • G.711 µlaw – 64 Kbps, sample-based, used in the United States
  • G.722 – 64 Kbps,
  • Opus – 6-510 Kbps, 2.5 ms – 60 ms frame size
  • G.723.1 – 5.3/6.3 Kbps, 30 ms frame size
  • G.726 – 16/24/32/40 Kbit/s
  • G.729 – 8 Kbit/s, 10 ms frame size
  • GSM – 13 Kbps (full rate), 20 ms frame size
  • iLBC – 15 Kbps, 20 ms frame size: 13.3 Kbps, 30 ms frame size
  • Speex – 2.15 to 44.2 Kbps
  • LPC10 – 2.5 Kbit/s
  • H.261 Video – Used on ISDN lines with a resolution of 352×288
  • H.263 Video – Low-bit-rate encoding solution for videoconferencing
  • H.263+ Video – Extension of H.263 that provides additional features that improve compression on packet-switched networks.
  • H.264 Video – Offers an excellent balance between quality and size

Server status

Monitoring defines the alarms and notifications with which the system will monitor itself. Monitoring also allows you to define where notifications will be sent when alarms are triggered.

  • Monitor (mins):

    Time interval during which the system must check whether Asterisk is down. If it is, the system will try to start it and send a notification email about the stop/restart action.

  • Refresh type:

    Choose to refresh the system at a specific time of day or at regular intervals (every hour).
    (For example, if this option is set to "Time of day" and the "Refresh (Hours)" value is set to "2", the system will be reloaded every day at 02:00 hours.
    By setting this option to "Regular interval" and "Refresh (Hours)" to "2", the system will be reloaded every two hours).

  • Refresh (Hours):

    This field is only active when the “Refresh type” option is selected
    (For example, if the option "Refresh Type" = "Time of day" and this option is set to "2", the system will be reloaded every day at 02:00 hours. If you set "Refresh Type" to "Regular interval" and set this option to "2", the system will be reloaded every two hours).

  • Restart type:

    Choose to restart the system at a specific time of day or at regular intervals (every hour).
    (For example, if this option is set to "Time of day" and "Restarts (hours)" = "2", the system restarts every day at 2 o'clock. By setting this option to "Regular interval" and "Restart (hours)" = "2", the system will be restarted every two hours).

  • Restart (hours):

    This field is only active when the “Restart type” option is selected
    (For example, if the option 'Restart Type' = 'Time of day' and this option is set to '2', the system will restart every day at 02:00 hours. If you set 'Restart Type' to 'Regular interval' and set this option to '2', the system will restart every two hours).

  • Notification email:
    Email address to which the refresh/restart notification will be sent.

Hot Desking
Here you can set the Hot Desking security details.

  • Login attempt checking

    The login attempt verification option allows you to enable or disable login attempt verification for hot desking. When set to yes, users can define two additional options: Extension Blocked after X attempts and Phone blocked after X attempts.

  • Extension Blocked after X attempts

    This option allows the user to set the maximum number of unsuccessful attempts before the extension is locked. The default value is 3. Thus, if the phone operator makes three unsuccessful login attempts in a row during the same day, the extension will be locked.

  • Phone blocked after X attempts

    This option sets the number of locked extensions after which the phone (device) should be locked. The default value is 9, which means that after nine extensions on the same device are locked, the device will be locked.

  • Automatic logout

    When this option is set to yes, it enables the automatic logout feature. When enabled, hot desking phones log out after X hours of inactivity.
    This option can also be set per extension, under Extensions Advanced Options -> Hot Desking, and in that case, it will override this setting and use the value set in the extension's Hot Desking section.

  • Log out after X hours of inactivity
    In this field, the user can define the idle time required to restart the phone, in hours. The default value is 4 hours.

At each login, the system checks whether the number of extensions blocked per device is equal to or greater than what is defined on the settings/servers page. This way, you can unblock the phone by simply increasing the values on this page. For example, if the option “Phone Blocked after X attempts” is set to 3 and there are 3 blocked extensions on that day, the phone (device) will be blocked and no one will be able to log in from that device until an administrator unlocks the extensions.

Now, if someone sets the “Phone Locked after X attempts” option to 4, the phone will be available until an additional extension is locked.

Features

  • Hide the caller ID in OSC
    This option allows you to hide or not the enhanced services caller ID in the online supervisor (OSC). Set this option to "Yes" to prevent users from modifying the caller ID.
  • Force “Allow Enhanced Services caller ID” for call forwarding
    Forces the display of the caller ID of the user who transferred the call.
    (For example, John calls Michael and Michael transfers the call to Steven. Steven will see that Michael is calling him instead of seeing John).
  • Default call group/pickup group
    Set the call/pickup group that will be set as default for extensions.
  • Ringtone for local calls
    Set a default custom ring tone for local calls.
  • Emergency caller identification
    The caller ID entered here will be used only for calls to emergency service numbers.
  • Set the caller number for call forwarding and hunt group calls
    If the numbers defined in the “Call Forwarding and Ring Simultaneously” feature have one or more remote numbers, these numbers will receive a different caller ID when calling. This caller ID is that of the original caller defined in the “Caller ID” enhanced services for the Trunk through which the call passed.
  • Allow caller ID only if the DID exists
    If calls from another server go through the multi-user extension of this system and the caller IDs from the other server match the DIDs of this server, they are correctly displayed to the call recipients. Otherwise, the caller ID is displayed as “Anonymous”.
  • Rejection of anonymous calls
    Enable this option to drop calls whose caller ID is anonymous.
  • Update of the Enhanced services/Caller ID/Trunks backup on DID

    When this option is enabled and a user registers a DID, a number is set as the caller ID on the extension it points to. The DID number will also be set for the Trunk where it is assigned, on the extension's enhanced services caller ID.

  • Do not allow users to send any Caller ID

    Do not allow users to send the Caller ID during a call. If this option is set to “Yes”, users will not be able to send a Caller ID during a call.

  • Hide Extensions with no department (Communicator)
    If an extension has no assigned department (for example, the department is set to "None"), this extension will not be displayed in communicator.
  • Disable local DID matching
    If this option is set to “Yes”, the system will disable the local DID lookup and instead go through a trunk to look for a match on another system.
  • Uses dynamic features
    Asterisk allows users to define custom functions for Asterisk applications.
    Using dynamic features, a user can send a DTMF to activate a specific dial plan. For example, when set to "No", a user will not be able to pause recordings, but they will be able to use direct media.
  • Disable call rating for call forwarding
    Select whether call rating will be disabled or enabled for the part of the call after it has been transferred.
  • Record IVR calls
    Select whether IVR call recording should be enabled. By default, IVR calls are not recorded, but if a user wants to use IVR statistics, they must enable IVR call recording.
  • Allow IP address authentication for extensions
    Allow IP address authentication for extensions and force IP address based authentication.
    When this field is enabled, the following fields are enabled for each extension:
    1. inbound IP addresses
    2. insecure
  • Skip the voicemail PIN code prompt
    By default, when entering an extension's voicemail box (by dialing *123), the user is prompted to enter their PIN code. If this option is set to “Yes”, the system will not ask for the PIN code and the user will access voicemail immediately.
  • Enable directory synchronization management
    Select “Yes” to enable directory synchronization management. If you select “No” or “Not set”, directory synchronization management will not be visible anywhere in the system, including in email templates, reports, and settings.
  • Hide the IP address in CLIR
    Indicate whether the IP address will be hidden in CLIR or not.

Do not call extensions in DND
Indicate whether the IP address should be displayed for Trunks.

Other networks

The system can be part of the "default" PBXware network where all extensions share the same unified dial plan. To do this, simply select the PBXware network the system belongs to in the selection box.

By clicking on “Other networks”, the following options open:

  • Mode:

    Defines how other PBXware networks are dialed.

    • With access code – Access code + network number + extension
    • Without access code (single-digit dialing) – network number only + extension
  • Name:

    Name of the other network.

  • Prefix:

    Displays the prefix of the other network.

  • Prefix band:

    Indicates the value chosen for the Prefix Strip option when adding/editing the other network.

  • Matches type:

    Indicates the type of matching defined for the Match type option.

  • Match:

    Indicates the value that will be used for matching.

  • Hidden prefix:

    Displays the value of the hidden prefix.

  • SIP account:

    Trunk used once the other network number has been dialed.

  • Click here to edit the configuration of the other networks.
  • Click here to delete the other network connection.+

For users to be able to use 2- or 3-digit prefixes, you must enable the “Mode: * with access code”, a 2- or 3-digit prefix. After configuring this option, you must dial *188 XXX YYYYYY, where XXX is the 3-digit prefix and YYYYYY is the phone number you want to dial.

If you have enabled "Mode: * without access code" (1-digit dialing), users will be able to dial the numbers defined with your 1-digit prefixes without using the *188 access code, by simply typing X YYYYYY, where X is your 1-digit prefix and YYYYYYY is the number you want to dial.

Add/Edit a network

  • Name:

    Customize the name of the Other network.

  • Prefix:

    Number used to access other networks (maximum 3 digits).
    (For example, if this field is set to '7', dial '*188 7 {NETWORK NAME}').

  • Prefix band:

    Should the prefix be removed when dialing the number of the other network?
    (For example, if the "Prefix" field is set to "7" and this field is enabled, when the user dials *188 7 55510205, the system dials 55510205. If this field is disabled, 755510205 will be dialed).

  • Matches type:

    Range of numbers allowed to be dialed after the *188 access code of the Other network
    Different types of matching can be chosen.

    • Interval: Select the range of numbers allowed to be dialed on this network.
    • Starts with:

      All numbers that begin with the entered digit(s) will be allowed to pass through the network.

    • Regex:
      The type of an entry in the Match Type field must be a regular expression. Suppose we want to enter "7" as the prefix number. In this case, the correct entry with prefix 7 is: [0-9]{3}. The first part of the expression [0-9] represents a digit from 0 to 9. And {3} represents the quantity (3 digits from 0 to 9). The correct solution is also: [0-9][0-9][0-9]. It is important to mention that the prefix must be excluded from the regular expression, since it is already included by entering a digit in the Prefix field.
  • Match:

    The value for which the match type rule will be applied. It can be one of the following values:

    • A range of numbers for the Matches type.
      (For example, 200000-200999)
    • Starting digits of the numbers for the Match type Starts with.
    • A regular expression for the Regex match type.
  • Hidden prefix:
    Prefix added before the dialed number
    (For example, if this field is set to 212 and we dialed *188 7 55510205, the number 21255510205 will be dialed. This is useful if the provider requires a certain code before dialing the destination, if the area code is inserted automatically, etc.).
  • SIP account:
    Select the trunk that will be used for calls passing through this network.
Emergency call notifications

When an emergency number, such as 112, is dialed, an automated call is placed to a specified number, extension, or ring group, broadcasting an announcement indicating that 112 was dialed from this extension.

  • Enable:
    Choose whether to enable or disable notifications for emergency calls.
  • Notify first only:
    Indicate whether you wish only the first destination to be notified in the event of an emergency call. (If this setting is set to “No”, each configured destination will receive the playback individually, if it answers).
  • Notify destinations:
    Enter the destinations you wish to be notified in the event of an emergency call.
  • Notify the caller ID:
    Add a custom caller number that will be used for emergency calls (it will be displayed on the configured destination).

Example: Extension 101 dials 112. The automated call is sent to extensions 102, 103 and 104. The person who answers will hear "1-1-2 was dialed from extension 1-0-1".

File sharing

Options for the file-sharing service used by the desktop and mobile apps.

  • Maximum file transfer size (MB):
    Maximum allowed size for sending files using desktop and mobile applications.

Additional proxy configuration

Here, users can add custom/hidden proxy configuration parameters.

Protocols

A protocol is a set of rules that allows the UAD, systems, networks, etc. to communicate using a defined standard.
The supported protocols are as follows:

  • SIP
  • IAX
  • RTP

SIP

SIP (Session Initiation Protocol) is a signaling protocol for Internet conferencing, telephony, presence, event notification and instant messaging. The protocol initiates call setup, routing, authentication and other function messages to endpoints within an IP domain.

General

  • Port:
    SIP server port to bind to
    (default value 5060,)
  • Bound IP address :
    IP address to which the SIP server should bind (0.0.0.0 binds to all interfaces)
    (default value 0.0.0.0,)
  • Default context:
    Default context for incoming calls
    (For example, for security reasons, it is recommended to leave this field as "invalid-context").
  • Default music on hold:
    Set the default Music on Hold class for all SIP calls
    (For example, set “default” to play the “default” Music on Hold class for all SIP calls when they are placed on hold).
  • Default call parking:
    Sets the default parking lot for call parking.
    This parameter can also be set for individual users/peers. Parking lots are configured in features.conf
  • Allow SIP transfers:
    Disable all transfers (unless enabled in peers or users). The default value is enabled.
  • Asynchronous operations:
  • Allow transport refresh:
  • Outbound proxy:
    This option allows PBXware to send outbound signaling to this proxy, instead of sending it directly to the peer.

TCP settings

  • Enable TCP:
    Enable the server for incoming TCP connections. (Default value: No)
  • External TCP port:
    This option allows you to set the external port number for incoming TCP connections.
    The default port used for TCP connections is 5060. ([0-9])
  • TCP Keep-alive interval
    This function sends \r\n\r\n packets to the TCP/TLS endpoints in order to prevent NAT from closing the port due to inactivity.
    Enter the time in seconds after which the \r\n\r\n packets will be sent. The default value is 20 seconds. ([0-9])

TLS settings

  • Enable TLS:
    Enable the server for incoming TLS (secure) connections
    (for example: Yes, No, Not set)
  • TLS port:
    This port overrides all TCP/UDP parameters in the SIP protocol settings and applies to all users (external and internal).
  • External TLS port:
    This option allows you to set an external port number for incoming TLS connections.
  • TLS handshake timeout:
    Controls the timeout for the TLS handshake.
  • TLS TCP Keep-Alive:
    Enable the TLS TCP Keep-Alive socket option so that the kernel removes stalled established TCP connections.
  • TLS TCP User Timeout:
    Enable the TLS TCP_USER_TIMEOUT socket option to remove stalled established TCP connections more quickly.
  • Use TLS for gloCOM:
    Set to 'Yes' to force gloCOM Mobile/Desktop to use SIP TLS.

NAT

  • External IP address (: UDP port) :

    External/public/Internet IP address used by the system.
    If your system is behind a NAT, set this option to the public/Internet IP address used by the system when registering with other proxy servers on the Internet. If this field is not filled in, users will experience one-way audio recording from the WAN.

  • External hostname (:UDP Port):
    DynDNS address used by the system
    If your system is behind a NAT, you can use the UDP service in addition to the external IP address.
  • Local networks (separated by a line break):
    If the system is used in a local network, define the local network address here
    (For example 192.168.0.0/255.255.0.0)
  • NAT:
    Global SIP NAT setting that affects all users/peers.
    Options:
    • yes – forces RFC 3581 behavior and enables symmetric RTP support.
    • no – only enables RFC 3581 behavior if the remote party requests it and disables symmetric RTP support.
    • force_rport – forces RFC 3581 behavior and disables symmetric RTP support.
    • comedia – enables RFC 3581 behavior if the remote side requests it and enables symmetric RTP support

Security

  • OPTIONS packets requested:
    Enabling this option allows OPTIONS requests to be authenticated in the same way as INVITE requests. By default, this option is disabled.
    Options: Yes, No, N/A

RTP timer

  • RTP delay (sec):
    Maximum RTP timeout
    (For example, all calls (if they are not on hold) will be interrupted if there is no RTP activity for the number of seconds defined here (60 for example)).
  • RTP timeout (sec:
    Maximum RTP wait time.
  • RTP keep-alive (sec):
    Send keep-alives in the RTP stream to keep NAT open (default, disabled – zero).

SIP Timers

  • Default T1 timer (MS):
    Default T1 timeout.
    The default value is 500 ms or the measured round-trip time to a peer (qualify=yes).
  • Call setup timer (MS):
    Call setup timer.
    If a provisional response is not received within this time frame, the call automatically drops. The default value is 32000 ms.

SIP session duration

  • Session timers mode:
    The session timer feature operates in the following three modes:
    • originate: always requests and runs session timers.
    • accept: Run session timers only on request from another UA.
    • decline: do not run session timers under any circumstances.
  • Call setup timer (MS):
    Minimum session refresh interval in seconds.
    The default value is 90 seconds.
  • Max session refresh interval (s):
    Maximum session refresh interval in seconds.
    The default value is 1800 seconds.

DTMF

  • DTMF Mode:

    The choices are inband, rfc2833, info, or auto:

    • inband: The device on which you press the key generates the DTMF tones. If the codec is not ulaw or alaw, the DTMF tones will be distorted by audio compression and will not be recognized. If the phone is set to RFC2833 and Asterisk is set to inband, you may not hear anything.
    • rfc2833:http://www.ietf.org/rfc/rfc2833.txt
    • info: See SIP info method and SIP info DTMF or http://www.ietf.org/rfc/rfc2976.txt
    • auto: Asterisk will use rfc2833 for DTMF relay by default but will switch to in-band DTMF tones if the remote side does not indicate support for rfc2833 in SDP. This feature was added on September 6, 2005 and is not available in Asterisk 1.0.x.
  • Relax DTMF:
    Relax DTMF handling
    (For example, set this field to "Yes" if you have problems with DTMF modes)

Quality of Service (QOS)

  • SIP TOS:
  • Audio TOS:
  • Video TOS:
    Available options: CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13, AF21, AF22, AF23, AF31, AF32, AF33, AF41, AF42, AF43, EF
  • 802.1p CoS SIP:
  • 802.1p CoS Audio:
  • 802.1p CoS Video:
    Available options: 0-7

Remote-Party-Id

The From header provides basic caller ID data, but it is too easy to modify, block, or spoof to be useful to the network. The Remote Party ID header is added by one of the network's servers and should therefore provide much more reliable and trustworthy identification than the From header, which can be set by users at the client device level. Another approach is described in the RFC 3325. It explains the requirements for providing an authenticated caller ID within a trusted network, using the P-Asserted-Identity (PAI) header to convey the authenticated identity of a caller, as well as a separate Privacy header to indicate whether this data should be hidden.

  • Allow Remote-Party-ID:

    Sets whether PBXware allows the Remote-Party-ID header.

  • Sending Remote-Party-ID:

    Whether to add "Remote-Party-ID" to the uri.
    Options:

    • Use Remote-Party-ID – Uses the “Remote-Party-ID” header to send the identity of the remote party.
    • Use P-Asserted-Identity – Use the “P-Asserted-Identity” header to send the identity of the remote party.

Other

  • Send the diversion header:

    The new version of PBXware includes a new SIP header that will display the standard caller ID details as well as information about the number from which the call is being transferred.
    The "From" and "Via" information is enabled by default but can be disabled by setting this option to No.

  • Maximum number of hops:
    The Max-Forwards header limits the number of hops a request can make on the way to its destination. It is an integer that is decremented by one at each hop. If the Max-Forwards value reaches 0 before the request reaches its destination, it is rejected with a 483 ("Too Many Hops") error response.
    The default value is 70
  • DTMF in the conversation:

    Inband means that the DTMF is transmitted within the audio of the phone conversation, i.e. it is audible to the parties. Set whether the system generates an inband ringtone.
    (For example, it is recommended to set this option to “Never”).

  • Compact headers:

    You can set compact headers to yes or no. If this option is set to yes, SIP headers will use a compact format, which may be necessary if the SIP header size is larger than the maximum transmission unit (MTU) of your IP headers, causing the IP packet to fragment. Do not use this option if you do not know what you are doing.
    (For example, it is recommended to set this option to “No” unless otherwise indicated).

Authentication

  • User agent:
    Set the user agent string
    (for example, “Custom string”)
  • Domain:
    Domain for digest authentication
    (for example, “Custom string”)

Recording

  • Default expiry (s):
    Default duration (in seconds) for incoming/outgoing recordings.
    Default value: 3600 seconds.
  • Minimum expiry (s):
    Minimum duration (in seconds) for incoming recordings
    Default value: 60 seconds.
  • Maximum expiry (s):
    Maximum duration (in seconds) for incoming recordings.
    Default value: 7200 seconds.
  • Maximum number of connected devices:
    Maximum number of contacts per extension. This number is set by default at the global level.
    It can be changed by changing the maximum number of contacts per extension.

MWI

  • MWI From header:
    When sending MWI NOTIFY requests, use this parameter in the From: header as the "name" part. Also fill in the "user" part of the URI in the From: header with this value if no "fromuser" is defined. Default value: empty
  • Outbound MWI expiry:
    Outgoing MWI subscriptions timeout (seconds).
    Default value: 3600.
  • MWI Task Processor queue size:
    This option gives us information about the number of task processor queues for a certain number of messages it needs to process.

Subscriptions

  • Allow subscriptions:
    Disable subscription support. The default value is Yes.

Codecs

  • Automatic framing (RTP packetization):
    If auto-framing is enabled, the system will choose the packetization level based on the preferences of the remote users.

Session Description Protocol

  • T38 support:
    The value of this field enables T.38 fax support on SIP calls with different options. The default value is disabled.
  • Session name:
    This field allows you to modify the SDP session name string. Like the useragent parameter, the default user agent string also contains the Asterisk version.
  • Session owner selection:
    This field allows you to modify the username field in the SDP owner string.

Threadpool

Asterisk's threadpool can be modified to achieve better performance.

In the asterisk logs, you can find messages such as:

The ‘<name>’ task processor queue reached <number> scheduled tasks.

In this case, you are probably experiencing thread pool overload, and the parameters below give you the ability to improve performance.

In the worst case, the PJSIP dialogs start to break down.

  • Initial Threadpool size:

    Initial Threadpool size. The default value is 10.

  • Threadpool auto increment:

    When additional threads are needed, how many should be created. The default value is 5.

  • Threadpool idle timeout:

    Number of seconds a thread must be idle before it disappears. 0 means threads never stop. The default value is 120.

  • Maximum Threadpool size
    Maximum number of threads in the Stasis thread pool. The default value is 100.

Additional configuration

This option is used to provide additional configuration parameters for the SIP configuration files. The values provided here will be written to these configuration files.

IAX

IAX (Inter Asterisk eXchange) is a simple, low-cost and low-bandwidth VoIP protocol designed to allow multiple PBXs to communicate with each other without resorting to more complex protocols.

General

  • Port:

    IAX binding port.

  • Bind address :

    This allows you to bind IAX to a specific local IP address instead of binding it to all addresses. This could be used to improve security if, for example, you wanted IAX to be available only to users on your local network.

  • IAX compatible:

    Whether to use layered switches or another scenario?
    (For example, set to yes if you plan to use layered switches or another scenario that may cause a delay when searching the dial plan).

  • Language:

    Default language settings for all users/peers.
    (For example, set this option to "fr" (French), for example).

  • Bandwidth:

    Set the bandwidth to control the codecs used in general
    (for example, choosing between low, medium or high).

  • Maximum number of IAX helper threads:

    Determines the number of additional dynamic threads that can be created to handle I/O.

  • Allow downloading the IAXy firmware:

    Controls whether this host will serve firmware to IAX clients that request it.

Jitterbuffer

  • Jitter Buffer:

    Disables the jitter buffer for this peer.

  • Force the jitter buffer:

    Should the jitter buffer be forced (default value 10)
    (For example, the jitter buffer is usually handled by the UADs/Phones. But in case they do it poorly, the jitter buffer can be forced on the PBXware side).

  • Max jitterbuffer interpolations:

    Maximum number of interpolation frames the jitter buffer should return in a row.

  • Jitter Buffer Max:

    Maximum jitter buffer size. By setting a reasonable maximum, you will prevent the call delay from reaching ridiculous values in extreme situations; you will hear SOMETHING, even if it is jitter.

  • Resynchronization threshold:
    Resync the detection threshold for a change in the measured delay.

Call rating

  • AMA flags:

    AMA = Automated Message Accounting.+
    These indicators are used in the generation of call detail records (for example, "default").

    • default: Sets the system default value.
    • omit: Does not record calls.
    • billing: Marks the entry for call billing
    • documentation: Mark the entry for documentation
  • Account code:

    Default account for CDR (Call Detail Records)

Authorization

  • Auth debugging:
    Should authentication be debugged?
    (For example, if this option is set to "Yes", the debugging traffic will be greater).
  • Maximum auth request:
    Maximum number of authentication requests awaiting responses. Any new authentication attempt will be blocked.
  • Rejection delay:
    Set this option to “Yes” to strengthen security against brute-force password attacks.

Recording

  • Recording context:

    If the specified PBXware dynamically creates and destroys a priority 1 NoOp extension for a given peer that registers or unregisters with us.

  • Min registration expiry:

    Minimum duration that IAX peers can request as a registration expiry interval (in seconds).

  • Max registration expiry:
    Maximum duration that IAX peers can request as a registration expiry interval (in seconds).

SIP account

  • Trunk frequency:
    Frequency of sending trunk msgs (in ms).
  • Trunk timestamps:
    Whether to send timestamps for individual subframes in the trunk frames.

Other

  • Disable UDP Checksums:
    Should checksums be calculated?
  • Auto-Kill:
    If no response is received within 2000ms, and this option is set to yes, the operation is canceled.

Codecs

  • Codec priority:
    This option controls the codec negotiation of an incoming IAX call.
    Example:
    • Caller – Consider the caller's preferred order before the host's.
    • Host – Considers the host's preferred order before that of the caller.
    • Disabled – Completely disables the consideration of codec preferences (this is the original behavior before preferences were added)
    • Request only – Same as disabled, but does not take capabilities into account; if the requested format is not available, the call will only be accepted if the requested format is available.

Additional configuration

This option is used to provide additional configuration parameters for the IAX configuration files.

The values provided here will be written to these configuration files.

RTP

General

  • RTP start port:

    Start port used for RTP.

  • RTP end port:

    End port used for RTP.

  • RTP Checksums:

    Enable or disable UDP Checksums on RTP traffic.

  • Strict RTP protection:

    This function allows RTP packets that do not originate from the recognized source of the RTP stream to be rejected. Strict RTP qualifies the sources of RTP packet streams before accepting them at the initial connection and when the connection is renegotiated (for example, transfers and direct media).
    The initial connection and the renegotiation start a learning mode to qualify the addresses of the stream sources. Once Asterisk has recognized a stream, it allows other streams to qualify and replace the current stream for 5 seconds after the learning mode is started. Once the learning mode is complete, the current stream is locked and can no longer be changed until the next renegotiation.
    This option is enabled by default.

Opus

  • Opus adaptive bitrate:
    It is used for mobile devices in order to improve audio performance in case of a poor network.

Additional configuration

This option is used to provide additional configuration parameters for the RTP configuration files. The values provided here will be written to these configuration files.

Operators

PBXware comes with a range of preconfigured VoIP and PSTN providers to make it easier to add trunks to the system. This screen allows you to add a custom provider.

  • Provider:
    Provider name.
  • Protocol:
    Protocol used by the provider.
  • Type:
    Service type.
  • Edit the provider configuration.
  • Delete the provider configuration.

Add a custom operator

  • Configuration
    • Choose a type:
      Service type (VoIP or PSTN).
    • Protocol:
      Protocol used by the provider. Depending on the service type, SIP, IAX and DAHDI are offered.
    • Name
      Provider name (for example Generic Analog).

PSTN

DAHDI

General

  • Country:

    Destination of the trunk connection.

  • National dialing code:

    National dialing code of the provider's destination.
    (For example, for the United States 1, the United Kingdom, Germany 0)

  • International dialing code:

    International dialing code of the provider's destination.
    (For example, for the United States 011, the United Kingdom, Germany 00)

  • E.164:

    Does the provider support dialing destinations in E164 format?
    (For example, enabling this option will reformat any dialed number into the following form: COUNTRY CODE + LOCAL CODE + DIALED NUMBER. For example, if the user dials 55510205, the system will dial 121255510205).

  • Pass-thru mode:

    If this option is enabled, the dialed number is passed through the trunk without modification.

  • Leave National Code:

    In some countries, the national code is automatically removed. If this setting is set to "Yes", the national code will not be removed from the dialed number.

  • Local phone code:

    Add the local area code to the dialed number if your service provider requires it. (By default, the local area code is removed when dialing the number).
    (For example, the user dials 55510205, and the local area code is 212. If the call goes through this trunk, PBXware will dial 21210205).

  • Write the dial code:
    Should the national and international prefix be written in the configuration files?
  • DAHDI devices:
    Select the DAHDI device that will be used.
    The options offered are as follows:
    • X100P
    • TDM400P
    • TDM10B
    • TDM20B
    • TDM30B
    • TDM40B
    • TDM11B
    • TDM12B
    • TDM13B
    • TDM21B
    • TDM22B
    • TDM23B
    • T100P
    • E100P
    • TE110P
    • TE410P
    • TE405P
    • hfcISDN
    • quadBRI

VoIP

This is where you select the VoIP type for which you are going to create a custom provider.

SIP

General

  • User type:

    The user's relationship with the system

    • user – The provider only accepts inbound calls
    • peer – The provider only makes outbound calls
    • friend – The provider makes inbound and outbound calls.
  • DTMF (Dual Tone Multi-Frequency) mode:

    DTMF mode used by the provider. A specific frequency (made up of two distinct tones) is assigned to each key so that it can be easily identified by a microprocessor.
    Example:
    inband – inband audio (requires a 64 kbit codec – alaw, ulaw).
    rfc2833 – default.
    info – SIP INFO messages.

  • Country:
    Destination of the trunk connection.
  • National dialing code:
    National dialing code used at the provider's destination.
    (For example, for the United States 1, the United Kingdom and Germany 0)
  • International dialing code:
    International dialing code used by the destination's provider.
    (For example, for the United States 011, the United Kingdom and Germany 00)
  • E.164 accepted:
    Does the network support dialing destinations in E164 format?
    (For example, enabling this option will reformat any dialed number into the following form COUNTRY_CODE + LOCAL_CODE + DIALED NUMBER. For example, if the user dials 55510205, the system will dial 121255510205).
  • Pass-thru mode:
    If this option is enabled, the dialed number is passed through the trunk without modification.
  • Leave National Code:
    In some countries, the national code is automatically removed. If this setting is set to "Yes", the national code will not be removed from the dialed number.
  • Local phone code:

    Add a local area code to the dialed number if your service provider requires it. (By default, the local area code is removed when dialing the number).
    (For example, the user dials 55510205, the local area code is 212. If the call goes through this trunk, PBXware will dial 21210205).

Network link

  • Transport:

    Type of transfer protocol that will be used on PBXware.

    • UDP (User Datagram Protocol) - is used mainly to establish low-latency and loss-tolerant connections between applications on the internet. UDP allows process-to-process communication. With UDP, computer applications can send messages, called datagrams in this case, and it is considered a "best-effort" mode of communication. UDP is considered a connectionless protocol because it does not require the establishment of a virtual circuit before any data transfer.
    • TCP (Transmission Control Protocol) - ensures the reliable, ordered and verified transmission of a stream of bytes between programs running on computers connected to an intranet or the public internet. TCP sends individual packets and is considered a reliable means of transport.
    • TLS (Transport Layer Security) - a cryptographic protocol that ensures the security of communications over the internet.[1] It uses asymmetric cryptography for the authentication of the key exchange, symmetric encryption for confidentiality and message authentication codes for message integrity.
    • TLS (Transport Layer Security) - a cryptographic protocol that ensures the security of communications over the internet.[1] It uses asymmetric cryptography for the authentication of the key exchange, symmetric encryption for confidentiality and message authentication codes for message integrity.
  • Encryption:
    This option enables or disables encryption in the PBXware transport.
    The options offered are as follows:
    • Offer if possible(TLS only)
      Offers encryption only if it is possible and only with the TLS protocol.
    • Required
      Encryption is always required.
    • Offer(TLS only)
      Always offers encryption, but only with the TLS protocol.
  • Media Direct:
    Whether you allow RTP voice traffic to bypass Asterisk.
    Options:
    • No – this option tells Asterisk to never send a reinvite to the client.
    • Yes – sends a re-invite to the client.
    • No NAT – allows reinvite locally, denies reinvite over NAT.
    • Update usage – uses UPDATE instead of INVITE.
    • No NAT update – use UPDATE locally, reject in NAT.
  • Direct RTP:
    Here you can enable or disable the new experimental direct RTP configuration.
    The value "yes" allows the call to be established directly with "peer-to-peer" media without re-invitation. This will not work for video and in cases where the caller sends RTP payloads and fmtp headers in the 200 OK that do not match the caller's INVITE. It will also fail if mediadirect is enabled while the device is behind a NAT.
  • Default IP:
    IP address to use until registration.

Channels

  • Inbound limit:

    Number of simultaneous incoming calls the provider can handle.
    (For example, 4 = four simultaneous incoming calls. Any additional call will be given a busy tone).

  • Outbound limit:

    Number of simultaneous outgoing calls the provider can handle.
    (For example, 4 = four simultaneous outgoing calls. Any additional call attempting to use this provider will be rejected or redirected to other providers depending on the settings defined in the system/extensions).

  • Busy level:

    Limits the number of simultaneous active inbound calls.

  • Apply busy level for inbound calls:

    Indicates whether the busy level will be applied to incoming calls.

  • Busy destination for incoming calls:

    If an extension has a busy level set and the busy level matches, the system will try to contact the busy level destination.
    This option can only be used if the busy level is set to Yes.

  • Busy destination for voicemail:

    Indicates whether the busy level destination will be a voicemail.

  • Send an email when the limit is exceeded:

    Send an email when the inbound/outbound limit is reached.

  • Outbound call options:

    Advanced dialing options for all outbound calls
    By default, this field is empty.

  • Dialing options:
    • t – Allows the called user to transfer the call by pressing #.
    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until one of them answers. Use this option with caution and do not insert it by default in all your dial instructions, as you destroy call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and additionally generates ringtones where it is probably not appropriate to do so.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass any audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is incompatible with the “r” option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (sending the original Caller ID) in Asterisk v1.2 (default: sending the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x).
    • M (x) – Runs the macro (x) when connecting to the call (i.e., when the called party answers).
    • h – Allows the called party to hang up by dialing *.
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command.
    • P (x) – Use the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Play an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d – This flag takes precedence over the 'H' flag and intercepts any DTMF while the call is waiting to be answered and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warning when "y" minutes remain, repeated every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (taken from app_dial.c).
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds to the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if ‘y’ is set. If LIMIT_WARNING_FILE is not set, the default behavior is to announce (“You have [XX minutes] YY seconds”).
    • f – forces the caller ID to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller ID for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or what is defined in features.conf, requires Set(DYNAMIC_FEATURES=automon).
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon).

Authentication

  • Host:
    Provider IP address
    (Enter the IP address of the host, 192.168.1.1 for example, or set "dynamic" if the host is behind a dynamic IP address).
  • Peer host:
    The IP of a peer host system sends the calls to
    (for example 192.168.1.1).
  • Auth:
    Global credentials for outgoing calls, i.e. when a proxy asks your PBXware to authenticate, these credentials take precedence over any credentials in the peer/registration definition if the domain is the same.
  • Inbound IP addresses
    (separated by new line):
    If your provider has several IP addresses from which it sends traffic, all these IP addresses must be indicated here, separated by a new line.
  • Insecure:
    Which of the selected options are not used for authentication.
    Example:
    • Port – Disregards the port number from which the request originates.
    • Invite – Does not require authentication of incoming INVITEs.
    • Port,Invite – Does not require authentication of the initial INVITE and ignores the port from which the request originates.
    • very – Ignores authentication (username/password).
  • Save:
    Registration method on the remote server. Providers may require a different registration method on their server. The user can choose the following options:
    • Not required
    • Test the phone number
    • With username
    • With identification name
    • With authname@host
    • With authname@trunk-name
  • Registry suffix:
    The service provider may require different registration methods for its services. Select the appropriate method according to the provider’s requirements.
  • Default expiry (s):
    Duration of the recording before the session expires.

Codecs

  • ITU G.711 ulaw – 64 Kbps, sample-based, used in the United States
  • ITU G.711 alaw – 64 Kbps, sample-based, used in Europe
  • Opus
  • ITU G.722
  • ITU G.723.1 – 5.3/6.3 Kbps, 30 ms frame size
  • ITU G.726 – 16/24/32/40 Kbps
  • ITU G.726 AAL2
  • ITU G.729 – 8 Kbps, 10 ms frame size
  • GSM – 13 Kbps (full rate), 20 ms frame size
  • iLBC – 15 Kbps, 20 ms frame size: 13.3 Kbps, 30 ms frame size
  • Speex – 2.15 to 44.2 Kbps
  • SpeeX 16
  • SpeeX 32
  • LPC10 – 2.5 Kbps
  • H.261 Video – Used on ISDN lines with a resolution of 352×288
  • H.263 Video – Low-bit-rate encoding solution for videoconferencing
  • H.263+ Video – Extension of the H.263 standard that offers additional features improving compression on packet-switched networks.
  • H.264 Video
  • Video support:
    This option enables or disables video support in PBXware.
  • Automatic framing (RTP packetization):
    Automatically adjusts the size of RTP packets with the registered device.

Jitter Buffer

  • Jitter Buffer:
    • Inherit – inherits the Jitter Buffer settings from the tenant configuration.
    • Fixed – Sets a fixed Jitter Buffer on the channel.
    • Adaptive – Sets an adaptive Jitter Buffer on the channel.
    • Disabled – Removes a Jitter Buffer previously set on the channel.
  • Max Length (ms):
    Buffer length in milliseconds. By default, it is 200 ms.
  • Re-synchronization threshold):
    Duration in milliseconds beyond which a timestamp difference will trigger a resynchronization of the Jitter Buffer. The default value is 1000 ms.
  • Extra target:
    This parameter only affects the adaptive Jitter Buffer. It represents the time in milliseconds by which the size of the new Jitter Buffer will be increased. The default value is 40.

 Provider-specific configuration

This option allows you to enter the provider-specific configuration parameters for the IAX configuration files.

IAX

General

  • User type:

    The user's relationship with the system

    • user – The provider only accepts inbound calls
    • peer – The provider only makes outbound calls
    • friend – The provider makes inbound and outbound calls.
  • DTMF (Dual Tone Multi-Frequency) mode:

    DTMF mode used by the provider. A specific frequency (made up of two distinct tones) is assigned to each key so that it can be easily identified by a microprocessor.
    Example:
    inband – inband audio (requires a 64 kbit codec – alaw, ulaw).
    rfc2833 – default.
    info – SIP INFO messages.

  • Country:

    Destination of the trunk connection.

  • National dialing code:

    National dialing code used at the provider's destination.
    (For example, for the United States 1, the United Kingdom and Germany 0)

  • International dialing code:

    International dialing code used by the destination's provider.
    (For example, for the United States 011, the United Kingdom and Germany 00)

  • E.164 accepted:

    Does the network support dialing destinations in E164 format?
    (For example, enabling this option will reformat any dialed number into the following form COUNTRY_CODE + LOCAL_CODE + DIALED NUMBER. For example, if the user dials 55510205, the system will dial 121255510205).

  • Pass-thru mode:

    If this option is enabled, the dialed number is passed through the trunk without modification.

  • Leave National Code:

    In some countries, the national code is automatically removed. If this setting is set to "Yes", the national code will not be removed from the dialed number.

  • Local phone code:
    Add a local area code to the dialed number if your service provider requires it. (By default, the local area code is removed when dialing the number).
    (For example, the user dials 55510205, the local area code is 212. If the call goes through this trunk, PBXware will dial 21210205).

Network link

  • Default IP:
    IP address to use until registration.

Channels

  • Inbound limit:
    Number of simultaneous incoming calls the provider can handle
    (For example, 4 equals four simultaneous incoming calls. Any additional call will be given a busy line announcement).
  • Outbound limit:
    Number of simultaneous outgoing calls the provider can handle
    (For example, 4 equals four simultaneous outgoing calls. Any additional call attempting to use this provider will be rejected or redirected to other providers depending on the settings defined in the system/extensions).
  • Apply busy level for inbound calls:
    Indicates whether the busy level will be applied to incoming calls.
  • Busy destination for incoming calls:
    If an extension has a busy level set and the busy level matches, the system will try to contact the busy level destination.
    This option can only be used if the busy level is set to Yes.
  • Busy destination for voicemail:
    Indicates whether the busy level destination will be a voicemail.
  • Send an email when the limit is exceeded:
    Sending an email when the outbound limit is reached.
  • Outbound call options:
    Advanced dialing options for all outbound calls. By default, this field is empty.
  • No transfer:

    Disable native IAX transfer.

  • ANI sending:

    ANI – Automatic number identification
    Should the ANI ("super" caller ID) be sent through this provider?

  • SIP account:

    Use IAX2 trunking with this host.

  • Outbound call options:

    Advanced dialing options for all outbound calls
    By default, this field is empty.

    Dialing options:

    • t – Allows the called user to transfer the call by pressing #.

    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until one of them answers. Use this option with caution and do not insert it by default in all your dial instructions, as you destroy call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and additionally generates ringtones where it is probably not appropriate to do so.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass any audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is incompatible with the “r” option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (sending the original Caller ID) in Asterisk v1.2 (default: sending the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x).
    • M (x) – Runs the macro (x) when connecting to the call (i.e., when the called party answers).
    • h – Allows the called party to hang up by dialing *.
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command.
    • P (x) – Use the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Play an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d – This flag takes precedence over the 'H' flag and intercepts any DTMF while the call is waiting to be answered and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warning when "y" minutes remain, repeated every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (taken from app_dial.c).
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds to the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if ‘y’ is set. If LIMIT_WARNING_FILE is not set, the default behavior is to announce (“You have [XX minutes] YY seconds”).
    • f – forces the caller ID to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller ID for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or what is defined in features.conf, requires Set(DYNAMIC_FEATURES=automon).
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon).

Authentication

  • Encryption:

    Should encryption be used when authenticating with the peer?

  • Host:

    Provider IP address
    (Enter the IP address of the host, 192.168.1.1 for example, or set "dynamic" if the host is behind a dynamic IP address).

  • Peer host:

    IP of a peer host system that sends calls to
    (For example 192.168.1.1)

  • Save:

    Registration method on the remote server. Providers may require a different registration method on their server. The user can choose the following options:

    • Not required
    • Test the phone number
    • With username
    • With identification name
    • With authname@host
    • With authname@trunk-name
  • Registry suffix:
    The service provider may require different register methods for its services. Select the appropriate method according to the provider’s requirements.
  • Authentication method:
    Authentication method required by the provider.
    The least secure is “plaintext”, which sends passwords in clear text over the network.
    The “md5” uses an md5 sum challenge/response arrangement, but still requires that both parties have access to the clear-text secret.
    rsa” allows one-way knowledge of the secret through public/private keys. If “rsa” authentication is used, “inkeys” is a list of acceptable public keys on the local system that can be used to authenticate the remote peer, separated by the ” :” character.
    rs4
  • RSA key:
    RSA authentication key
    (For example, if the authentication method is set to RSA, provide the RSA key here)

Codecs

  • ITU G.711 ulaw – 64 Kbps, sample-based, used in the United States
  • ITU G.711 alaw – 64 Kbps, sample-based, used in Europe
  • ITU G.722 – 48, 56 and 64 Kbps, sample-based
  • Opus – 6 Kbps - 510 Kbps, five sampling rates from 8 kHz to 48 kHz
  • ITU G.723.1 – 5.3/6.3 Kbps, 30 ms frame size
  • ITU G.726 – 16/24/32/40 Kbps
  • ITU G.726 AAL2
  • ITU G.729 – 8 Kbps, 10 ms frame size
  • GSM – 13 Kbps (full rate), 20 ms frame size
  • iLBC – 15 Kbps, 20 ms frame size: 13.3 Kbps, 30 ms frame size
  • Speex – 2.15 to 44.2 Kbps
  • SpeeX 16
  • SpeeX 32
  • LPC10 – 2.5 Kbps
  • H.261 Video – Used on ISDN lines with a resolution of 352×288
  • H.263 Video – Low-bit-rate encoding solution for videoconferencing
  • H.263+ Video – Extension of the H.263 standard that offers additional features improving compression on packet-switched networks.
  • H.264 Video

Jitter Buffer

  • Jitter Buffer:
    • Inherit
      Inherits the Jitter Buffer settings from the tenant configuration.
    • Fixed
      Sets a fixed Jitter Buffer on the channel.
    • Adaptive
      Sets an adaptive Jitter Buffer on the channel.
    • Disabled
      Deletes a Jitter Buffer previously set on the channel.
  • Max length (ms):

    Buffer length in milliseconds. By default, it is 200 ms.

  • Re-synchronization threshold:

    Duration in milliseconds beyond which a timestamp difference will trigger a resynchronization of the Jitter Buffer. The default value is 1000 ms.

  • Extra target:

    This parameter only affects the adaptive Jitter Buffer. It represents the time in milliseconds by which the size of the new Jitter Buffer will be increased. The default value is 40.

Provider-specific configuration

This option allows you to enter the provider-specific configuration parameters for the IAX configuration files.

Default trunk

The system uses its trunks to make calls to various destinations. In order to allow an organization to control its voice communications budget and provide fallback termination, the default trunks make it possible to define primary, secondary, and tertiary trunks.

The system will use the primary trunk as the first choice for each destination called. If, for any reason, the primary line fails to complete the call, the secondary trunk will be used by the system. If, for any reason, the secondary trunk fails to complete the call, the tertiary trunk will be used by the system.

  • Primary/Secondary/Tertiary Trunk:
    Allows you to select the default trunks at the system level.
  • Default destination:

    Default destination to which trunks without a DID will be forwarded.
    (For example, if there is no DID for an incoming trunk/provider, all calls will be forwarded to this system number).

Priority

Settings:

    • Default trunks: All system calls go through the trunks defined here.

Extensions:

    • The trunks defined in the advanced options of the extensions override the default trunks defined in Settings > Default trunks.

UAD

UADs (User Agent Devices) are IP phones, softphones, ATAs (Analog Telephone Adaptors) and IADs (Integrated Access Devices) used for the system extensions. PBXware supports a wide range of UADs using the SIP, IAX, MGCP and DAHDI protocols.

Supported devices are already preconfigured with the most common settings to make it easy for administrators to add extensions. However, some PBXware installations have specific requirements, so it is advisable to edit the selected UAD and configure it with the required values. Additionally, if an installation needs to use an unlisted UAD, clicking "Add user agent" allows you to add a new UAD.

Search


The search in UADs is available in 3 ways:

  • Brand – search by the brand name
  • Status – search by the extension's status on the network
  • Search for a user agent by typing its name

End of life

All end-of-life devices are now correctly indicated on the Bicom Systems Wikimedia site in the UAD section.

  • As for the PBXware graphical interface:
    To see which devices are end-of-life, freely navigate to the tab Settings > select the UAD page and a selection box indicating "End of life" will be displayed. Simply choose ‘Yes’ if you want to see the list of end-of-life devices.

Requirements

Add/Edit

Click “Add user agent” to add a device or click the “Edit” icon next to a device to modify its settings.

  • Protocol:
    Select the protocol used by the UAD (User Agent Device). The available options are SIP, IAX, and DAHDI.
    Note: depending on the chosen protocol, adding/modifying a UAD will be different.

SIP

General

  • Device name:

    Unique name of the device.

  • DTMF (Dual Tone Multi-Frequency) mode:

    A specific frequency made up of two distinct tones. A specific tone is assigned to each key so that it can be easily identified by a microprocessor. These are the tones generated on the keypad of your telephone device.
    (For example, each phone has a different “DTMF mode”. By default, this field is automatically filled in for supported devices. If you add other UAD/phones, select the ‘inband’, ‘rfc2833’ or ‘info’ options).

  • Context:
    Each extension on the system belongs to a certain system context. The context can be described as a collection/group of extensions. The default context used by PBXware is “default” and should not be used by custom extensions.
  • Status:
    Device status/presence on the network
    If this field is set to “Active”, this UAD/phone will be available by default in the “UAD” selection box when adding new extensions.)
  • Internal UAD name for auto-provisioning:
    This is where you define how the system will recognize the UAD internally

Related network

  • Transport:

    Type of transfer protocol that will be used on PBXware.

    • UDP (User Datagram Protocol) - is used mainly to establish low-latency and loss-tolerant connections between applications on the internet.
      UDP enables process-to-process communication. With UDP, computer applications can send messages, in this case called datagrams, and it is considered a "best-effort" mode of communication. UDP is considered a connectionless protocol because it does not require the establishment of a virtual circuit before any data transfer.
    • TCP (Transmission Control Protocol) - ensures the reliable, ordered and verified transmission of a stream of bytes between programs running on computers connected to an intranet or the public internet. TCP sends individual packets and is considered a reliable means of transport.
    • TLS (Transport Layer Security) - a cryptographic protocol that ensures the security of communications over the internet[1] and that uses asymmetric cryptography for the authentication of the key exchange, symmetric encryption for confidentiality and message authentication codes for message integrity.
  • Encryption:

    This option enables or disables encryption in the PBXware transport.
    The options offered are as follows:

    • Offer if possible (TLS only)
      Offers encryption only if it is possible and only with the TLS protocol.
    • Required
      Encryption is always required.
    • Offer (TLS only)
      Always offers encryption, but only with the TLS protocol.
  • NAT (Network Address Translation):

    Set the appropriate Extension – PBXware NAT relationship
    Example:
    If extension 1000 tries to register with PBXware from a remote site/network and that network is behind a NAT, select the appropriate NAT settings here:

    • Yes – Always ignore the information and assume it is a NAT.
    • No – Use NAT mode only according to RFC3581.
    • Default (rport) – force_rport – forces RFC 3581 behavior and disables symmetric RTP support.
    • Comedia RTP – enables RFC 3581 behavior if the remote side requests it and enables symmetric RTP support.
  • Media direct:

    This option tells the Asterisk server never to issue a re-invite to the client, if set to No.
    Available options:

    • No
      If this option is set to ‘No’, Asterisk will never send a re-invite to the client.
    • Yes
      Asterisk will send a re-invite to the client.
    • Non-NAT only
    • Update usage
    • No NAT update
  • Direct RTP:

    Here you can enable or disable the new experimental direct RTP configuration. The value “yes” allows the call to be established directly with peer-to-peer media without a re-invite. This will not work for video and in cases where the caller sends RTP payloads and fmtp headers in the 200 OK that do not match the caller’s INVITE. It will also fail if MediaDirect is enabled while the device is behind a NAT.

  • Qualification(ms):
    Time interval in milliseconds during which a "ping" is sent to the UAD/phone or trunk, in order to know its status (online/offline).
    Qualification is set to 8000 by default.
    (For example, set this option to "2500" to send a ping signal every 2.5 seconds to the UAD/phone or trunk).

Call properties

  • Phone code:

    Area code from which the UAD operates.
    (For example, the New York area code – 212)

  • Ring time (sec):

    Ring duration of the UAD/phone. This is the time in seconds during which the UAD/Phone will ring before the call is considered unanswered.
    The default value is 32 seconds.

  • Inbound Call Options:

    Advanced dialing options for all inbound calls
    The default value is tr.
     (default value: tr)).

  • Outbound Call Options:

    Advanced dialing options for all outbound calls. The default value is empty.

Slices

  • Inbound limit:

    Maximum number of incoming calls.

  • Outbound limit:
    Maximum number of outgoing calls.
  • Busy level:
    Maximum number of simultaneous incoming calls until the user/peer is busy.
  • Apply busy level for inbound calls:
    Indicates whether the busy level will be applied when the maximum number of simultaneous incoming calls is reached.
  • Busy destination for incoming calls:
    Define the extension/number to which the call will be redirected if the busy level is reached.
  • Busy voicemail destination:
    Select “yes” if you want voicemail to be a busy destination.

Codecs

Sets the codecs the extension is allowed to use.

  • Video support:

    Set this option to Yes to enable SIP video support.

  • Automatic framing (RTP packetization):

    If auto-framing is enabled, the system will choose the packetization level based on the preferences of the remote users.

Auto Provisioning

  • Auto Provisioning:
    Enable the auto-provisioning service for this particular model.
    (For example, connect the UAD/Phone to PBXware without any problem by providing the UAD/Phone's MAC address (and optionally adding the UAD/Phone's static IP address and network details)).
  • DHCP:
    Define whether the UAD/Phone is on a DHCP address or a static IP address.
    Set DHCP to 'Yes' if the UAD/Phone is on a dynamic IP address, or DHCP to 'No' if the UAD/Phone is on a static IP address. If the UAD/Phone is on a static IP address, you will need to provide more network details in the fields below.

Presence

  • Presence enabled:

    Presence allows the UAD to subscribe to the indications used for BLF.

  • Global Presence

Additional configuration

  • General user agent auto provisioning template: 

    General user agent auto provisioning template
    Here, users can define a custom configuration that will be served to all phones of the same model.

  • User agent auto provisioning template:

    User agent auto provisioning template
    This option is used to provide additional configuration parameters for the SIP, IAX, and MGCP configuration files. The values provided here will be written to these configuration files.
    The following variables can be used:

    • %EXT_NUMBER% – Extension number
    • %EXT_NAME% – Extension name
    • %MAC_ADDRESS% – MAC address of the extension (the MAC from the auto-provisioning request)
    • %WAN_IP% – WAN/IP hostname defined in Servers > Edit
    • LAN_IP% – LAN Hostname/IP defined in Servers > Edit
    • %AUTH_USERNAME% – HTTP username
    • %AUTH_PASSWORD% – HTTP username
    • %VM_PIN% – Extension voicemail PIN
    • %EXT_SECRET% – Extension secret
    • %EXT_LABEL% – Extension label
    • %EXT_TITLE% – Extension title

  • User agent-specific configuration:

  • Dialing options
    • t – Allows the called user to transfer the call by pressing #.
    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until one of them answers. Use this option with caution and do not insert it by default in all your dial instructions, as you remove call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and also generates ringtones where it is probably not appropriate.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is mutually exclusive with the ‘r’ option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (send the original Caller ID) in Asterisk v1.2 (default: send the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x)
    • M (x) – Runs the macro (x) when connecting the call (i.e., when the called party answers)
    • h – Allows the called party to hang up by dialing *
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command
    • P (x) – Uses the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Plays an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d: – This flag takes precedence over the 'H' flag and intercepts any DTMF while waiting for the call to be picked up and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warn when "y" minutes remain, repeat every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (pasted from app_dial.c)
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds for the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if “y” is set. If LIMIT_WARNING_FILE is not set, the default behavior is to play a warning file (LIMIT_WARNING_FILE).
    • f – forces the caller identification to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller identification for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or any other parameter defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
      IAX

IAX

General

  • Device name:
    Unique name of the device.
  • DTMF mode:
    A specific frequency, made up of two distinct tones. A specific tone is assigned to each key so that it can be easily identified by a microprocessor. These are the tones generated on the keypad of your telephone device.
    (For example, each phone has a different “DTMF mode”. By default, this field is automatically filled in for supported devices. If you add another UAD/phone, select the “inband”, “rfc2833” or “info” options).
  • Context:
    Each extension on the system belongs to a certain system context. The context can be described as a collection/group of extensions. The default context used by PBXware is “default” and should not be used by custom extensions.
  • Status:
    Device status/presence on the network
    (For example, if this field is set to "Active", this UAD/phone will be available by default in the "UAD" selection box when adding new extensions).

Network link

  • NAT (Network Address Translation)

    Set the appropriate Extension – PBXware NAT relationship.
    If extension 1000 tries to register with PBXware from a remote site/network and that network is behind a NAT, select the appropriate NAT settings here:

    • Yes – Always ignore the information and assume it is NAT
    • No – Use NAT mode only according to the RFC3581 standard
    • Default (rport) – this setting enforces RFC3581 behavior and disables symmetric RTP support.
    • Comedia RTP – enables RFC3581 behavior if the remote side requests it and enables symmetric RTP support.
  • Qualification(ms):
    Time interval in milliseconds during which a 'ping' is sent to a UAD/phone or a trunk in order to know its status (online/offline).
    In PBXware 6.0, the ‘Qualify’ option is set by default to 8000 ms.
    (For example, set this option to '2500' to send a ping signal every 2.5 seconds to the UAD/phone or trunk).

Call properties

  • Phone code:
    Phone code from which the UAD operates.
    (For example, the New York area code – 212)
  • Ring time (sec):
    UAD/phone ringing time. This is the time in seconds during which the UAD/Phone will ring before the call is considered unanswered.
    (For example, the time in seconds that the UAD/Phone will ring before the call is considered unanswered).
  • Inbound call options:
    Advanced dialing options for all inbound calls
    The default value is 32s.
  • Outbound call options:
    Advanced dialing options for all outbound calls. The default value is empty.

Channels

  • Inbound limit:
    Maximum number of incoming calls.
  • Outbound limit:
    Maximum number of outgoing calls.
  • Apply busy level for inbound calls:
    Indicates whether the busy level will be applied when the maximum number of simultaneous incoming calls is reached.
  • Busy destination for incoming calls:
    Define the extension/number where the call will be redirected if the occupancy level is applied.
  • Busy voicemail destination:
    Select “yes” if you want voicemail to be a busy destination.
  • No transfer:
    Disable native IAX transfer.
  • ANI sending:
    ANI – Automatic number identification
    Should the ANI ("super" caller ID) be sent through this provider?
  • SIP account:
    Use IAX2 trunking with this host

Authentication

  • Authentication method:
    Authentication method required by the provider
    • none – does not use authentication
    • plaintext – uses plaintext as a means of authentication
    • md5 – uses an md5 sum challenge/response arrangement, but still requires both parties to have access to the plaintext secret.
    • rc4
    • rsa – allows one-way knowledge of the secret through public/private keys. If “rsa” authentication is used, “inkeys” is a list of acceptable public keys on the local system that can be used to authenticate the remote peer, separated by the “:” character.

Codecs

Sets the codecs the extension is allowed to use. N/A means “not allowed”.

Auto Provisioning

  • Auto Provisioning:
    Enable the auto-provisioning service for this particular model.
    (For example, connect the UAD/Phone to PBXware without any problem by providing the UAD/Phone's MAC address (and optionally adding the UAD/Phone's static IP address and network details)).
  • DHCP:
    Define whether the UAD/Phone is on a DHCP address or a static IP address.
    Set DHCP to 'Yes' if the UAD/Phone is on a dynamic IP address, or DHCP to 'No' if the UAD/Phone is on a static IP address. If the IP address is static, you will need to provide more network details in the fields below.

Presence

  • Presence enabled:
    Presence allows the UAD to subscribe to hints that are used for BLF.
  • Global presence

Additional Config
Additional configuration for Auto Provisioning on the following pages can use template variables :

  • General user agent auto-provisioning template:

    Here, users can define a custom configuration that will be served to all phones of the same model.

  • User agent auto provisioning template:

    This option is used to provide additional configuration parameters for the SIP, IAX, and MGCP configuration files. The values provided here will be written to these configuration files.

The following variables can be used:

    • %EXT_NUMBER% – Extension number
    • %EXT_NAME% – Extension name
    • %MAC_ADDRESS% – MAC address of the extension (the MAC from the auto-provisioning request)
    • %WAN_IP% – WAN/IP hostname defined in Servers > Edit
    • LAN_IP% – LAN Hostname/IP defined in Servers > Edit
    • %AUTH_USERNAME% – HTTP username
    • %AUTH_PASSWORD% – HTTP username
    • %VM_PIN% – Extension voicemail PIN
    • %EXT_SECRET% – Extension secret
    • %EXT_LABEL% – Extension label
    • %EXT_TITLE% – Extension title
  • User agent-specific configuration:

  • Dialing options
    • t – Allows the called user to transfer the call by pressing #.
    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until one of them answers. Use this option with caution and do not insert it by default in all your dial instructions, as you remove call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and also generates ringtones where it is probably not appropriate.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is mutually exclusive with the ‘r’ option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (send the original Caller ID) in Asterisk v1.2 (default: send the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x)
    • M (x) – Runs the macro (x) when connecting the call (i.e., when the called party answers)
    • h – Allows the called party to hang up by dialing *
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command
    • P (x) – Uses the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Plays an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d: – This flag takes precedence over the 'H' flag and intercepts any DTMF while waiting for the call to be picked up and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warn when "y" minutes remain, repeat every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (pasted from app_dial.c)
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds for the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if “y” is set. If LIMIT_WARNING_FILE is not set, the default behavior is to play a warning file (LIMIT_WARNING_FILE).
    • f – forces the caller identification to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller identification for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or any other parameter defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
      IAX

DAHDI

DAHDI General

  • Device name:

    Unique name of the device.

  • Channels:

    What are the card channels used?

  • Language:

    Default language.

  • Status:

    Device status/presence on the network
    (For example, if this field is set to "Active", this UAD/phone will be available by default in the "UAD" selection box when adding new extensions).

  • Signaling:

    Signaling method
    Possible choices:

    • E&M
    • E&M Wink
    • FXS Loopstart
    • FXS Groundstart
    • FXS Kewlstart
    • FXO Loopstart
    • FXO Groundstart
    • FXO Kewlstart
    • PRI CPE side
    • PRI Network side
    • BRI Network side
    • BRI CPE PTMP
    • BRI Network PTMP
  • Test number:

    This number is used for trunk monitoring in Monitor -> Trunks Settings -> Monitor Trunks.

  • Music on hold:

    Select the music class to be used for music on hold. If not specified, the “default” value will be used.

  • Voicemail:

    Set a voicemail context.
    (for example 1234, 1234@context)

  • Group method:

    It specifies the group to dial and how to choose a channel to use within the specified group. The four possible options are as follows:

    • g: selects the lowest unoccupied DAHDI channel (also known as an ascending sequential hunt group).
    • G: selects the highest unoccupied DAHDI channel (also known as a descending sequential hunt group).
    • r: use a round-robin search, starting with the next highest channel relative to the last time (aka ascending rotary hunt group).
    • R: use a round-robin search, starting with the lowest channel following the last one (aka descending rotary hunt group).

Span

  • Span number:
    Span number.
  • Timing span:
    How to synchronize synchronization devices
    Example:
    • 0 – do not use this representation range as a synchronization source
    • 1 – use as primary synchronization source
    • 2 – as a secondary source, and so on
  • Line Build Out:
    Length of the last leg of the connection. The value is set to zero if the length is less than 133 feet.
    Example:
    • 0 db (CSU) / 0-133 feet (DSX-1)
    • 133-266 feet (DSX-1)
    • 266-399 feet (DSX-1)
    • 399-533 feet (DSX-1)
    • 533-655 feet (DSX-1)
    • -7,5db (CSU)
    • -15db (CSU)
    • -22,5db (CSU)
  • Framing:
    How to communicate with the hardware at the other end of the line.
    Example:
    • For T1: The framing is one of the following: d4 or esf.
    • For E1: the framing is one of the following: cas or ccs.
  • Coding:
    How to encode communication with the hardware at the other end of the line.
    Example:
    • For T1: the coding is ami or b8zs.
    • For E1: the encoding is one of the following: ami or hdb3 (E1 may also need a crc).
  • Yellow:
    Indicates whether the yellow alarm is transmitted when no channel is open.

Dynamic Span

  • Dynamic span driver:

    The name of the driver (e.g. eth)

  • Dynamic span address:

    Driver-specific address (such as a MAC for eth).

  • Dynamic span channels:

    Number of channels.

  • Dynamic span channels:
    Sets the synchronization priority, as for a normal range. Use “0” not to use it as a synchronization source, or give them priority as a primary, secondary, etc. source.

Echo Canceller

  • Echo cancellation:
    Enable/disable echo cancellation. You can choose echo cancellation between delays of 32, 64, 128 and 256 ms.
  • Echo training:
    Briefly mute the channel, for 400 ms, at the start of a conversation, which cancels the echo. (Use only if the "Echo Cancellation" option does not work as expected).
  • Echo cancellation when bridged:
    Enables echo cancellation when bridging. In general, it is not necessary, and in fact it is not desirable, to cancel echo when the circuit path is entirely TDM.
  • Echo Canceller:
    Echo canceller types:
    • mg2
    • oslec
    • kb1
      or none.

Jitterbuffer
A Jitterbuffer temporarily stores incoming packets in order to minimize delay variations. If packets arrive too late, they are discarded. A Jitterbuffer can be misconfigured and be too large or too small.

  • Enable Jitterbuffer:
    Enables the use of a Jitterbuffer on the receiving side of a SIP channel. An enabled Jitterbuffer will only be used if the sending side can create Jitter and the receiving side cannot accept it. The SIP channel can accept Jitter, so a Jitterbuffer on the receiving SIP side will only be used if it is forced and enabled.
  • Force Jitterbuffer:
    Whether to force the Jitterbuffer.
  • Max length (ms):
    Maximum jitterbuffer length in milliseconds.
  • Re-synchronization threshold:
    Resync the detection threshold for a change in the measured delay.
  • Implementation:
    Implementation of the Jitter buffer used on the receiving side of a SIP channel. The default value is “fixed”.
  • Error report:
    Enables Jitterbuffer frame error reporting. The default value is “no”.

Call indications

  • Distinctive ring detection:
    Whether or not to allow distinctive ring detection on FXO lines.
  • Busy detecting:
    Enabling monitoring of the busy detection beep.
  • Account busy:
    Number of busy tones to wait for before hanging up. Higher values reduce the likelihood of hanging up at random.
  • Call rate:
    Easily detect false hang-ups.
  • Immediate:
    The channel must be answered immediately or the simple switch must provide a tone, read the digits, etc.

Call groups

  • Call group:
    Set the call group to which the extension belongs.
    (Similar to the "Context" group, but this option defines the call group to which the extension belongs (allowed range: 0-63)).
  • Pickup group:
    Sets the call pickup groups as being allowed to pick up.
    (Similar to the 'Context' grouping, but this option allows defining the extension of the call groups as allowed to pick up by dialing '*8').

RX/TX

TX and RX are abbreviations for Transmit and Receive.

  • RX Wink:

    Set the synchronization parameters
    Example:

    • Pre-wink (50ms)
    • Pre-flash (50ms)
    • Wink (150ms)
    • Flashtime receiver (250 ms)
    • Wink receiver (300 ms)
    • Debounce timing (600 ms)
  • RX Gain:
    Decibel value of the receive signal.
  • TX Gain:
    Decibel value of the transmit signal.

Other DAHDI Options

  • ADSI :
    Allows remote control of the screen phone using programmable keys. (Only if you have ADSI-compatible CPE equipment)
  • Relax DTMF:
    If you experience difficulties with DTMF detection, you can relax the DTMF detection settings by setting this option to Yes.
  • Fax detection:
    Enable fax detection
    Possible options:
    • Inbound
    • Outbound
    • Anyone can give their feedback
    • No

PRI

PRI – Primary Rate Interface

  • SwitchType:

    Set the switch type
    Supported switch types:

    • National ISDN 2
    • Nortel DMS100
    • AT&T 4ESS
    • Lucent 5ESS
    • EuroISDN
    • Old National ISDN 1
    • Q.SIG
  • PRI Dial plan:

    The type of number (TON) or numbering plan used for the dialed number. For most installations, leaving this setting at "unknown" (default) works in most cases.
    Set the dial plan used by certain switches
    Available options:

    • Unknown
    • Private ISDN
    • Local ISDN
    • National ISDN
    • International ISDN
  • PRI Local dial plan:
    Set the dial plan for locally called destinations
    Available options:
    • Unknown
    • Private ISDN
    • Local ISDN
    • National ISDN
    • International ISDN
  • PRI trust CID:
    Caller ID information provided by Trust.
  • Simplified network installation:
    If the switch requires it, select the network-specific installation
    • none
    • sdn
    • megacom
    • accunet

Caller ID

  • Outbound caller ID:
    Caller ID set for all outbound calls when the caller ID is not defined or not supported by a device.
  • Allow caller ID in enhanced services:
    Should caller ID in enhanced services be allowed on this UAD?
  • Caller ID usage:
    Whether or not to use caller identification.
  • Hide caller identification:
    Whether or not to hide the outbound caller ID.
  • Restrict the CID:
    Whether or not to use caller ID presentation for the outbound call sent by the calling switch.
  • Use caller ID presentation:
    Whether or not to use caller ID presentation from the Asterisk channel for outbound calls.
  • CID Signaling:
    Set the caller ID signaling type
    Example:
    • Bell – US
    • v23 – United Kingdom
    • dtmf – Denmark, Sweden and Netherlands
  • Call waiting CID:
    Whether or not to enable call waiting on FXO lines.
  • Send CallerID after:
    Some countries, such as the United Kingdom, have different ring patterns, which means that the caller ID must be set later, and not just after the first ring, as is the case by default.

FXO channels
FXO – Foreign Exchange Office.

  • FXO Loopstart:

    Channels are signaled using the FXO Loopstart protocol.

  • Groundstart FXO:

    Channels are signaled using the FXO Groundstart protocol.

  • Kewlstart FXO:

    Channels are signaled using the FXO Kewlstart protocol.

The values of the fields above are defined as follows:

    • 1 – for one card.
    • 1-2 – for two cards.
    • 1-3 – for three cards, etc.
    • 2-3 (if your card has modules in the following order: FXS, FXO, FXO, FXS).

FXS channels
FXS – Foreign Exchange Subscriber.

  • FXS Loopstart:

    Channels are signaled using the FXS Loopstart protocol.

  • FXS Groundstart:

    Channels are signaled using the FXS Groundstart protocol.

  • FXS Kewlstart:

    Channels are signaled using the FXS Kewlstart protocol.

The values of the fields above are defined as follows:

    • 1 – for one card.
    • 1-2 – for two cards.
    • 1-3 – for three cards, etc.
    • 2-3 (if your card has modules in the following order: FXS, FXO, FXO, FXS).

PRI channels
The PRI uses the B and D channels. The B channels are used to carry voice calls and the D channel for signaling.

  • D-channel(s):
    Set the number of D channels.
  • B-channel/channels:
    Set the number of B channels.

Other DAHDI channels

  • unused
  • clear

Call functions

  • Call waiting:

    Whether or not to enable call waiting on FXO lines.

  • Three-way conference:

    Three-way calling support. If this feature is enabled, the call can be put on hold and you can make another call.

  • Transfer:

    Call transfer support and call parking activation.

  • Can forward the call:

    Set this parameter to “Yes” to enable call forwarding.

  • Callback:

    Whether or not call return is supported. If this setting is set to “Yes”, when the user dials “*69”, the system calls the extension number of the last caller.

  • Overlap Dial:
    Enable Overlap Dial mode (sending digits in Overlap)
    If the Overlap Dial mode is set to “No”, the gateway expects to receive the digits one after another on this line, with very little wait time between the digits. If the “overlap dial” setting is set to “Yes”, the device waits between the digits.
  • Pulse dialing:
    Use Pulse Dialing instead of DTMF dialing. Used by FXO devices (FXS signaling).

User agent-specific configuration

  • Dialing options:
    • t – Allows the called user to transfer the call by pressing #.
    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until they answer. Use this option with caution and do not insert it by default in all your dial instructions, as you remove call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and also generates ringtones where it is probably not appropriate.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is mutually exclusive with the ‘r’ option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (send the original Caller ID) in Asterisk v1.2 (default: send the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x)
    • M (x) – Runs the macro (x) when connecting the call (i.e., when the called party answers)
    • h – Allows the called party to hang up by dialing *
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command
    • P (x) – Uses the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Playing an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d: – This flag takes precedence over the 'H' flag and intercepts any DTMF while waiting for the call to be picked up and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warn when "y" minutes remain, repeat every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (pasted from app_dial.c)
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds for the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if “y” is set. If LIMIT_WARNING_FILE is not set, the default behavior is to announce (‘You have [XX minutes] YY seconds’).
    • f – forces the caller identification to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller identification for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or any other parameter defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

RPS Provisioning

RPS provisioning allows you to automatically provision the phone without having to enter the provisioning settings in the phone's user interface. To provision the phone this way, proceed as follows:

  • 1. Configure RPS Provisioning (if it has not been configured previously). To configure RPS Provisioning, see the page Configuration.
  • 2. Save the phone to the provider's redirection service. To do this, go to the page Devices, select the MAC address of the phone and click Save.
  • 3. Reset the phone to factory settings.

When adding a new extension or hot-desking device, it will be automatically registered with the provider's redirection service. For it to be registered and appear on the Devices, the following conditions must be met:

  • 1. TheUAD installed on the extension/hot desking device comes from a vendor listed in the Configuration.
  • 2. The extension location/hot desking device is set to Remote. Local devices cannot be provisioned using this service.
  • 3. The option to auto provisioning must be set to Yes. This applies only to extensions.

When the phone is reset, it automatically retrieves all the data needed for provisioning and is provisioned on the assigned phone.
Once the phone is provisioned, it will be removed from the provider's redirection service.

Devices

This page displays a list of all extensions and hot desking devices that can be provisioned using the RPS Provisioning service.

  • Save:
    Once one or more MAC addresses are selected, click the Save button to register the devices on the provider's redirection service.
    When the devices are registered, you can reset them and they will be provisioned on your server.
  • Unregister:
    Once one or more MAC addresses are selected, click the Unregister button to remove the devices from the provider's redirection service.
  • Status:
    Allows you to filter devices based on the status of their redirection service.
    • Saved: Displays all devices that are already registered with the provider's redirection service.
    • None: displays all devices that are NOT registered with the provider's redirection service.
  • Search:
    Allows you to filter devices by MAC address or UAD.
  • MAC address :
    Displays the device's MAC address.
  • Name:
    Displays the names of the extensions to which the MAC address is assigned.
  • Extension:
    Displays the extension numbers where the MAC is assigned.
  • UAD:
    Displays the UAD type of the device.
  • Status:
    The status can have two values:
    • Saved: The device is successfully registered with the provider's redirection service and is ready to be provisioned. To provision the phone, simply reset it.
    • None: The device is not registered with the operator's redirection service.
  • Registration date:
    Displays the date on which the device was registered. Empty if the device is not registered.
  • Last message:
    If a registration/deregistration request fails, an error message will be displayed here to indicate the problem.
    If no error message is present, this field is empty.

Configuration

This page presents a list of all available providers whose phones can be provisioned with the RPS Provisioning service. The currently supported providers are as follows:

    • Yealink
    • Snom

It is not possible to manually add a new provider. Existing providers cannot be deleted.

  • Provider:

    Displays the provider's name.

  • Status:
    Displays the provider's status.
    The status can be one of the following:
    • Disabled: The provider is disabled and is not used.
    • Temporary blacklist: If the system fails to contact the provider, it marks it as temporarily blacklisted and all requests for that provider are queued. When the provider becomes available again, the requests will be processed.
      (For example, a provider may be temporarily blacklisted in case of a network problem, etc.)
    • Blacklist: if the system recognizes that all requests sent to a provider will fail, the provider will be blacklisted, but all requests will be queued.
      (For example, if invalid configuration credentials are entered, all requests will fail and the provider will be blacklisted until the problem is resolved).
    • Enabled: The provider is enabled and ready to be used.
  • Message:
    Displays the last error message that occurred when sending requests to the provider. In case the provider is blacklisted, this message will tell us the reason for this error.

Jitterbuffer
A Jitterbuffer temporarily stores incoming packets in order to minimize delay variations. If packets arrive too late, they are discarded. A Jitterbuffer can be misconfigured and be too large or too small.

  • Enable Jitterbuffer:
    Enables the use of a Jitterbuffer on the receiving side of a SIP channel. An enabled Jitterbuffer will only be used if the sending side can create Jitter and the receiving side cannot accept it. The SIP channel can accept Jitter, so a Jitterbuffer on the receiving SIP side will only be used if it is forced and enabled.
  • Force Jitterbuffer:
    Whether to force the Jitterbuffer.
  • Max length (ms):
    Maximum jitterbuffer length in milliseconds.
  • Re-synchronization threshold:
    Resync the detection threshold for a change in the measured delay.
  • Implementation:
    Implementation of the Jitter buffer used on the receiving side of a SIP channel. The default value is “fixed”.
  • Error report:
    Enables Jitterbuffer frame error reporting. The default value is “no”.

Call indications

  • Distinctive ring detection:
    Whether or not to allow distinctive ring detection on FXO lines.
  • Busy detecting:
    Enabling monitoring of the busy detection beep.
  • Account busy:
    Number of busy tones to wait for before hanging up. Higher values reduce the likelihood of hanging up at random.
  • Call rate:
    Easily detect false hang-ups.
  • Immediate:
    The channel must be answered immediately or the simple switch must provide a tone, read the digits, etc.

Call groups

  • Call group:
    Set the call group to which the extension belongs.
    (Similar to the "Context" group, but this option defines the call group to which the extension belongs (allowed range: 0-63)).
  • Pickup group:
    Sets the call pickup groups as being allowed to pick up.
    (Similar to the 'Context' grouping, but this option allows defining the extension of the call groups as allowed to pick up by dialing '*8').

RX/TX

TX and RX are abbreviations for Transmit and Receive.

  • RX Wink:

    Set the synchronization parameters
    Example:

    • Pre-wink (50ms)
    • Pre-flash (50ms)
    • Wink (150ms)
    • Flashtime receiver (250 ms)
    • Wink receiver (300 ms)
    • Debounce timing (600 ms)
  • RX Gain:
    Decibel value of the receive signal.
  • TX Gain:
    Decibel value of the transmit signal.

Other DAHDI Options

  • ADSI :
    Allows remote control of the screen phone using programmable keys. (Only if you have ADSI-compatible CPE equipment)
  • Relax DTMF:
    If you experience difficulties with DTMF detection, you can relax the DTMF detection settings by setting this option to Yes.
  • Fax detection:
    Enable fax detection
    Possible options:
    • Inbound
    • Outbound
    • Anyone can give their feedback
    • No

PRI

PRI – Primary Rate Interface

  • SwitchType:

    Set the switch type
    Supported switch types:

    • National ISDN 2
    • Nortel DMS100
    • AT&T 4ESS
    • Lucent 5ESS
    • EuroISDN
    • Old National ISDN 1
    • Q.SIG
  • PRI Dial plan:

    The type of number (TON) or numbering plan used for the dialed number. For most installations, leaving this setting at "unknown" (default) works in most cases.
    Set the dial plan used by certain switches
    Available options:

    • Unknown
    • Private ISDN
    • Local ISDN
    • National ISDN
    • International ISDN
  • PRI Local dial plan:
    Set the dial plan for locally called destinations
    Available options:
    • Unknown
    • Private ISDN
    • Local ISDN
    • National ISDN
    • International ISDN
  • PRI trust CID:
    Caller ID information provided by Trust.
  • Simplified network installation:
    If the switch requires it, select the network-specific installation
    • none
    • sdn
    • megacom
    • accunet

Caller ID

  • Outbound caller ID:
    Caller ID set for all outbound calls when the caller ID is not defined or not supported by a device.
  • Allow caller ID in enhanced services:
    Should caller ID in enhanced services be allowed on this UAD?
  • Caller ID usage:
    Whether or not to use caller identification.
  • Hide caller identification:
    Whether or not to hide the outbound caller ID.
  • Restrict the CID:
    Whether or not to use caller ID presentation for the outbound call sent by the calling switch.
  • Use caller ID presentation:
    Whether or not to use caller ID presentation from the Asterisk channel for outbound calls.
  • CID Signaling:
    Set the caller ID signaling type
    Example:
    • Bell – US
    • v23 – United Kingdom
    • dtmf – Denmark, Sweden and Netherlands
  • Call waiting CID:
    Whether or not to enable call waiting on FXO lines.
  • Send CallerID after:
    Some countries, such as the United Kingdom, have different ring patterns, which means that the caller ID must be set later, and not just after the first ring, as is the case by default.

FXO channels
FXO – Foreign Exchange Office.

  • FXO Loopstart:

    Channels are signaled using the FXO Loopstart protocol.

  • Groundstart FXO:

    Channels are signaled using the FXO Groundstart protocol.

  • Kewlstart FXO:

    Channels are signaled using the FXO Kewlstart protocol.

The values of the fields above are defined as follows:

    • 1 – for one card.
    • 1-2 – for two cards.
    • 1-3 – for three cards, etc.
    • 2-3 (if your card has modules in the following order: FXS, FXO, FXO, FXS).

FXS channels
FXS – Foreign Exchange Subscriber.

  • FXS Loopstart:

    Channels are signaled using the FXS Loopstart protocol.

  • FXS Groundstart:

    Channels are signaled using the FXS Groundstart protocol.

  • FXS Kewlstart:

    Channels are signaled using the FXS Kewlstart protocol.

The values of the fields above are defined as follows:

    • 1 – for one card.
    • 1-2 – for two cards.
    • 1-3 – for three cards, etc.
    • 2-3 (if your card has modules in the following order: FXS, FXO, FXO, FXS).

PRI channels
The PRI uses the B and D channels. The B channels are used to carry voice calls and the D channel for signaling.

  • D-channel(s):
    Set the number of D channels.
  • B-channel/channels:
    Set the number of B channels.

Other DAHDI channels

  • unused
  • clear

Call functions

  • Call waiting:

    Whether or not to enable call waiting on FXO lines.

  • Three-way conference:

    Three-way calling support. If this feature is enabled, the call can be put on hold and you can make another call.

  • Transfer:

    Call transfer support and call parking activation.

  • Can forward the call:

    Set this parameter to “Yes” to enable call forwarding.

  • Callback:

    Whether or not call return is supported. If this setting is set to “Yes”, when the user dials “*69”, the system calls the extension number of the last caller.

  • Overlap Dial:
    Enable Overlap Dial mode (sending digits in Overlap)
    If the Overlap Dial mode is set to “No”, the gateway expects to receive the digits one after another on this line, with very little wait time between the digits. If the “overlap dial” setting is set to “Yes”, the device waits between the digits.
  • Pulse dialing:
    Use Pulse Dialing instead of DTMF dialing. Used by FXO devices (FXS signaling).

User agent-specific configuration

  • Dialing options:
    • t – Allows the called user to transfer the call by pressing #.
    • T – Allows the calling user to transfer the call by pressing #.
    • r – Generates a ringtone for the caller and passes no audio to the called channel(s) until they answer. Use this option with caution and do not insert it by default in all your dial instructions, as you remove call progress information for the user. You probably do not need to use this function. Asterisk automatically generates ringtones when it is appropriate to do so. 'r' moves it to the next step and also generates ringtones where it is probably not appropriate.
    • R – Indicates a ringtone to the caller when the called party indicates that it is ringing, but does not pass audio until they answer. This option is only available if you are using Kapejod's bristuff software.
    • m – Provides music on hold to the caller until they answer the call. This option is mutually exclusive with the ‘r’ option. Use m(class) to specify a class for the music on hold.
    • o – Restores Asterisk v1.0 Caller ID behavior (send the original Caller ID) in Asterisk v1.2 (default: send the number of this extension).
    • j – Asterisk 1.2 and above: Jump to priority n+101 if all requested channels are busy (as in Asterisk 1.0.x)
    • M (x) – Runs the macro (x) when connecting the call (i.e., when the called party answers)
    • h – Allows the called party to hang up by dialing *
    • H – Allows the caller to hang up by dialing *.
    • C – Resets the CDR (Call Detail Record) for this call. This is equivalent to using the NoCDR command
    • P (x) – Uses the privacy manager, using x as the database (x is optional).
    • g – When the called party hangs up, exit to execute other commands in the current context.
    • G (context^exten^pri) – If the call is answered, both parties are transferred to the specified priority. The caller is transferred to priority x and the called party to priority x+1.
    • A (x) – Playing an announcement (x.gsm) to the called party.
    • S (n) – Hang up the call n seconds AFTER the callee has answered.
    • d: – This flag takes precedence over the 'H' flag and intercepts any DTMF while waiting for the call to be picked up and returns that value on the spot. This allows you to dial a single-digit exit extension number while waiting for the call to be picked up – see also RetryDial.
    • D (digits) – After the called party has answered, send the digits as a DTMF stream, then connect the call to the original channel.
    • L (x[:y][:z]) – Limit the call to "x" minutes, warn when "y" minutes remain, repeat every "z" minutes). Only "x" is mandatory; "y" and "z" are optional. The following special variables are optional for limited calls: (pasted from app_dial.c)
    • + LIMIT_PLAYAUDIO_CALLER – yes|no (default yes) – Plays sounds to the caller.
    • + LIMIT_PLAYAUDIO_CALLEE – yes|no – Plays sounds for the callee.
    • + LIMIT_TIMEOUT_FILE – File to play when time has run out.
    • + LIMIT_CONNECT_FILE – File to play at the start of the call.
    • + LIMIT_WARNING_FILE – File to play as a warning if “y” is set. If LIMIT_WARNING_FILE is not set, the default behavior is to announce (‘You have [XX minutes] YY seconds’).
    • f – forces the caller identification to be set for the extension of the line placing/redirecting the outbound call. For example, some PSTNs do not allow the caller identification for extensions other than those assigned to you.
    • w – Allows the called user to start recording after pressing *1 or any other parameter defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)
    • W – Allows the calling user to start recording after pressing *1 or any other item defined in features.conf, requires Set(DYNAMIC_FEATURES=automon)

RPS Provisioning

RPS provisioning allows you to automatically provision the phone without having to enter the provisioning settings in the phone's user interface. To provision the phone this way, proceed as follows:

  • 1. Configure RPS Provisioning (if it has not been configured previously). To configure RPS Provisioning, see the page Configuration.
  • 2. Save the phone to the provider's redirection service. To do this, go to the page Devices, select the MAC address of the phone and click Save.
  • 3. Reset the phone to factory settings.

When adding a new extension or hot-desking device, it will be automatically registered with the provider's redirection service. For it to be registered and appear on the Devices, the following conditions must be met:

  • 1. TheUAD installed on the extension/hot desking device comes from a vendor listed in the Configuration.
  • 2. The extension location/hot desking device is set to Remote. Local devices cannot be provisioned using this service.
  • 3. The option to auto provisioning must be set to Yes. This applies only to extensions.

When the phone is reset, it automatically retrieves all the data needed for provisioning and is provisioned on the assigned phone.
Once the phone is provisioned, it will be removed from the provider's redirection service.

Devices

This page displays a list of all extensions and hot desking devices that can be provisioned using the RPS Provisioning service.

  • Save:
    Once one or more MAC addresses are selected, click the Save button to register the devices on the provider's redirection service.
    When the devices are registered, you can reset them and they will be provisioned on your server.
  • Unregister:
    Once one or more MAC addresses are selected, click the Unregister button to remove the devices from the provider's redirection service.
  • Status:
    Allows you to filter devices based on the status of their redirection service.
    • Saved: Displays all devices that are already registered with the provider's redirection service.
    • None: displays all devices that are NOT registered with the provider's redirection service.
  • Search:
    Allows you to filter devices by MAC address or UAD.
  • MAC address :
    Displays the device's MAC address.
  • Name:
    Displays the names of the extensions to which the MAC address is assigned.
  • Extension:
    Displays the extension numbers where the MAC is assigned.
  • UAD:
    Displays the UAD type of the device.
  • Status:
    The status can have two values:
    • Saved: The device is successfully registered with the provider's redirection service and is ready to be provisioned. To provision the phone, simply reset it.
    • None: The device is not registered with the operator's redirection service.
  • Registration date:
    Displays the date on which the device was registered. Empty if the device is not registered.
  • Last message:
    If a registration/deregistration request fails, an error message will be displayed here to indicate the problem.
    If no error message is present, this field is empty.

Configuration

This page presents a list of all available providers whose phones can be provisioned with the RPS Provisioning service. The currently supported providers are as follows:

    • Yealink
    • Snom

It is not possible to manually add a new provider. Existing providers cannot be deleted.

  • Provider:

    Displays the provider's name.

  • Status:
    Displays the provider's status.
    The status can be one of the following:
    • Disabled: The provider is disabled and is not used.
    • Temporary blacklist: If the system fails to contact the provider, it marks it as temporarily blacklisted and all requests for that provider are queued. When the provider becomes available again, the requests will be processed.
      (For example, a provider may be temporarily blacklisted in case of a network problem, etc.)
    • Blacklist: if the system recognizes that all requests sent to a provider will fail, the provider will be blacklisted, but all requests will be queued.
      (For example, if invalid configuration credentials are entered, all requests will fail and the provider will be blacklisted until the problem is resolved).
    • Enabled: The provider is enabled and ready to be used.
  • Message:
    Displays the last error message that occurred when sending requests to the provider. In case the provider is blacklisted, this message will tell us the reason for this error.
Share

25. Settings

Or copy the link below

CONTENT