Extensions Module - DAHDI Extension
THIS WIKI HAS BEEN UPDATED FOR VERSION 13 OF YOUR PBX GUI
Note
In PBX GUI software version 13 and above, fax options have moved from the Extensions module to the User Management module.
- 1 Overview
- 2 Logging in
- 3 Adding a DAHDI Extension
- 4 General
- 4.1 Add Extension
- 4.1.1 User Extension
- 4.1.2 Display Name
- 4.1.3 Outbound CID
- 4.2 User Manager Settings
- 4.2.1 Link to a Default User
- 4.2.2 Username
- 4.2.3 Password for New User
- 4.2.4 Groups
- 4.1 Add Extension
- 5 Voicemail
- 5.1 Voicemail
- 5.1.1 Enabled
- 5.1.2 Voicemail Password
- 5.1.3 Require From Same Extension
- 5.1.4 Disable ( * ) in Voicemail Menu
- 5.1.5 Email Address
- 5.1.6 Email Attachment
- 5.1.7 Play CID
- 5.1.8 Play Envelope
- 5.1.9 Delete Voicemail
- 5.1.10 VM Settings
- 5.1.11 VM Context
- 5.2 VMX Locater™
- 5.1 Voicemail
- 6 Find Me / Follow Me
- 6.1 General Settings
- 6.1.1 Enabled
- 6.1.2 Initial Ring Time
- 6.1.3 Ring Strategy
- 6.1.4 Ring Time
- 6.1.5 Follow-Me List
- 6.1.6 Extension Quick Pick
- 6.1.7 Announcement
- 6.1.8 Play Music On Hold
- 6.1.9 CID Name Prefix
- 6.1.10 Alert Info
- 6.2 Call Confirmation Configuration
- 6.2.1 Confirm Calls
- 6.2.2 Remote Announce
- 6.2.3 Too-Late Announce
- 6.3 Change External CID Configuration
- 6.3.1 Mode
- 6.3.2 Fixed CID Value
- 6.4 Destinations
- 6.4.1 No Answer
- 6.1 General Settings
- 7 Advanced
- 7.1 Assigned DID/CID
- 7.1.1 DID Description
- 7.1.2 Add Inbound DID
- 7.1.3 Add Inbound CID
- 7.2 Call Camp-On Services
- 7.2.1 Caller Policy
- 7.2.2 Callee Policy
- 7.3 Add Extension
- 7.3.1 channel
- 7.3.2 context
- 7.3.3 immediate
- 7.3.4 signalling
- 7.3.5 echocancel
- 7.3.6 echocancelwhenbridged
- 7.3.7 echotraining
- 7.3.8 busydetect
- 7.3.9 busycount
- 7.3.10 callprogress
- 7.3.11 dial
- 7.3.12 accountcode
- 7.3.13 callgroup
- 7.3.14 pickupgroup
- 7.3.15 mailbox
- 7.3.16 CID Num Alias
- 7.3.17 SIP Alias
- 7.4 Extension Options
- 7.4.1 Asterisk Dial Options
- 7.4.2 Ring Time
- 7.4.3 Call Forward Ring Time
- 7.4.4 Outbound Concurrency Limit
- 7.4.5 Call Waiting
- 7.4.6 Internal Auto Answer
- 7.4.7 Call Screening
- 7.4.8 Pinless Dialing
- 7.4.9 Emergency CID
- 7.4.10 Queue State Detection
- 7.5 Recording Options
- 7.5.1 Inbound External Calls
- 7.5.2 Outbound External Calls
- 7.5.3 Inbound Internal Calls
- 7.5.4 Outbound Internal Calls
- 7.5.5 On Demand Recording
- 7.5.6 Record Priority Policy
- 7.6 Dictation Services
- 7.6.1 Dictation Service
- 7.6.2 Dictation Format
- 7.6.3 Email Address
- 7.6.4 From Address
- 7.7 DTLS
- 7.7.1 Enable DTLS
- 7.7.2 Use Certificate
- 7.7.3 DTLS Verify
- 7.7.4 DTLS Setup
- 7.7.5 DTLS Rekey Interval
- 7.8 Optional Destinations
- 7.8.1 No Answer
- 7.8.1.1 CID Prefix
- 7.8.2 Busy
- 7.8.2.1 CID Prefix
- 7.8.3 Not Reachable
- 7.8.3.1 CID Prefix
- 7.8.1 No Answer
- 7.1 Assigned DID/CID
- 8 Other
- 8.1 Endpoint
- 8.2 iSymphony Settings
- 8.2.1 Add to iSymphony
- 8.2.2 Auto Answer
- 8.3 Device Options
- 8.3.1 Channel
- 8.3.2 Parkinglot
- 8.4 Language
- 8.4.1 Language Code
- 8.5 Default Group Inclusion
- 8.5.1 Default Page Group
- 8.5.2 Default VMblast Group
- 9 Saving the Extension
Overview
This guide walks you through information related to DAHDI (Digium Asterisk Hardware Driver Interface) extensions.
Options may vary based on installed modules. Configuration of these settings is covered by their respective user guides.
Logging in
From the top menu click Applications
From the drop down click Extensions
Adding a DAHDI Extension
From the Extensions landing page click on the Add New DAHDi Extension button.
General
Add Extension
User Extension
This will be the extension number associated with this user and cannot be changed once saved. We recommend using 3- or 4-digit extension numbers.
Display Name
This is the name associated with this extension and can be edited any time. This will become the Caller ID Name. Only enter the name, NOT the number.
Outbound CID
Overrides the CallerID when dialing out a trunk. Any setting here will override the common outbound CallerID set in the Trunks module. Format: "caller name" <#######>
Leave this field blank to disable the outbound CallerID feature for this user. If you leave it blank, the system will use the route or trunk Caller ID, if set.
User Manager Settings
Link to a Default User
Select a user that this extension should be linked to in the User Management module. Default = Create New User. An extension may only be linked to one user, and a user may only be linked to one extension.
Create New User: Creates a new user in User Manager that will be linked to this extension.
None: The extension will not be associated with a user in User Manager
Existing User: If you have any existing users in User Manager who are not already linked to an extension, you can select one here in order to link the user to this extension.
Username
If Create New User is selected above, this will be the new user's login username. If you leave the Username field is blank (grayed-out), the username will be the same as the extension number. To customize the username, check the Use Custom Username box and enter a username.
Password for New User
If Create New User is selected above, this will be the auto-generated user's new password. A password is automatically generated, but you can edit it here.
Groups
If Create New User is selected above, or if you are linking this extension to an existing user, you can add the user to one or more groups. Groups are defined in the User Management module, so if you haven't created any groups, none will show up here. To add this user to a group, click inside the field, and available groups will show up in a menu. You can start typing to quickly find a group. Click on a group name to add it to the field. Repeat the process if you with to enter multiple groups.
Voicemail
Click on the Voicemail tab.
If you wish to enable voicemail, click the Yes button next to Enabled in order to allow editing the options below.
Voicemail
Enabled
Yes/No: Whether to enable voicemail for the user.
Voicemail Password
Enter the password (numbers only) the user will use to access the voicemail system. If left blank, it will default to the extension number. The user can change the password after logging into the voicemail system (*98) with a phone.
Require From Same Extension
Yes/No: Whether to require the user to enter their password after they reach the voicemail system from their own extension, by dialing *97. This option does not apply to *98 calls, which will always prompt for a password. For security purposes, a Yes setting is recommended in an environment where other users will have physical access to this extension.
Disable ( * ) in Voicemail Menu
Yes/No: Whether to disable access to the voicemail menu. Default = Yes. If set to Yes, a user will not be able to access the voicemail menu by pressing "*". If you have no plans to access your mailbox remotely, set this to Yes. If set to No, the user can access voicemail remotely by calling into their extension and pressing "*" to reach the menu.
Email Address
Optional - The e-mail that voicemail notifications will be sent to. Further down the page, you have the option of whether to attach the actual voicemail message to the e-mail.
Pager Email Address
Optional - A pager e-mail address or mobile email address that short voicemail notifications will be sent to.
Email Attachment
Yes/No: Whether to attach the voicemail to the e-mail notification. Requires an email address to be set above.
Play CID
Yes/No: Whether to read back the caller's telephone number prior to playing the voicemail, just after announcing the date and time the message was left.
Play Envelope
Yes/No: Whether the system will play the message envelope information (date/time) before playing the voicemail message. This setting does not affect the operation of the envelope option in the advanced voicemail menu.
Delete Voicemail
Yes/No: Whether to delete the voicemail message from the mailbox after it is e-mailed to the user. If set to Yes, this would provide functionality that allows users to receive their voicemail via e-mail alone, rather than needing to retrieve it from the web interface or a telephone.
VM Settings
Optional: Advanced settings. Enter voicemail options, separated by the pipe symbol (|). For example, "review=yes | maxmessage=60" May be left blank.
VM Context
This is the Voicemail Context, which is normally set to "default." Do not change unless you understand the implications.
VMX Locater™
VMX Locater is designed to help a caller reach an operator and/or find you when you are not at your main phone. If enabled, the user will want to consider recording voicemail greetings that instruct a caller on which options to press (0, 1, and/or 2).
Whenever you enter information into the 0, 1, and/or 2 options below, you should run a test to make sure the number is functional, because otherwise the caller might become stranded or receive messages about a number being invalid.
Enabled
Yes/No: Whether to enable the VMX Locater feature. Set to Yes if you would like to enable this feature and edit the options below.
Use When
Select one or more of the buttons to enable VMX Locater for these types of greetings: Unavailable, Busy, and/or Temporary.
Voicemail Instructions
Yes/No: Whether to play instructions after playing your greeting. If set to No, only a beep will be played after your personal voicemail greeting.
Press 0
Check the Go to Operator box to send the caller to the operator when they press 0. Uncheck the Go to Operator box and enter an alternative destination if you want the caller to be sent to a different destination when they press 0. This feature is still accessible to callers even when VMX Locater is disabled for the user.
Press 1
Optional - Enter a destination to send the caller to when they press 1. This can be an internal extension, ring group, queue, or external number such as a cell phone number.
Press 2
Optional - Enter a destination to send the caller to when they press 2. This can be an internal extension, ring group, queue, or external number such as a cell phone number.
Find Me / Follow Me
Click on the Find Me / Follow Me tab.
Find Me / Follow Me is enabled by default here so that you may edit the settings. After entering settings, you can disable it if desired.
General Settings
Enabled
Yes/No: Whether to enable Find Me / Follow Me. Must be set to Yes (at least temporarily) in order to edit other settings on this page. If you leave it set to Yes, Find Me / Follow Me will be active for this extension when you save the extension and apply config. You can set to No to disable Find Me / Follow Me for an extension until the user activates it.
Initial Ring Time
Use the drop-down menu to select initial ring time, in seconds. This is the number of seconds to ring the primary extension prior to proceeding to the follow-me list. If "0," the primary extension will not be rung before proceeding to the follow-me list. The extension can also be included in the follow-me list.
Ring Strategy
ringallv2: ring Extension for duration set in Initial Ring Time, and then, while continuing call to extension, ring Follow-Me List for duration set in Ring Time.
ringall: ring Extension for duration set in Initial Ring Time, and then terminate call to Extension and ring Follow-Me List for duration set in Ring Time.
hunt: take turns ringing each available extension
memoryhunt: ring first extension in the list, then ring the 1st and 2nd extension, then ring 1st 2nd and 3rd extension in the list.... etc.
*-prim: these modes act as described above. However, if the primary extension (first in list) is occupied, the other extensions will not be rung. If the primary is in do-not-disturb (DND) mode, it won't be rung. If the primary is in call forward (CF) unconditional mode, then all will be rung.
firstavailable: ring only the first available channel
firstnotonphone: ring only the first channel which is not off hook - ignore CW
Ring Time
Time in seconds that the phones will ring. For all hunt-style ring strategies, this is the time for each iteration of phone(s) that are rung.
Follow-Me List
Enter a list of extensions to ring, one per line, or use the Extension Quick Pick menu below. You can include an extension on a remote system, or an external number, by suffixing a number with a pound (#). ex: 2448089# would dial 2448089 on the appropriate trunk (see Outbound Routing).
Extension Quick Pick
This drop-down menu gives you the option to select existing extensions to add to the Follow-Me List above.
Announcement
Select the message to be played to the caller before dialing the find me / follow me list. Default = none. The drop-down menu shows available system recordings. To add additional recordings, please use the System Recordings module.
Play Music On Hold
If you select a Music on Hold class to play, instead of the default "Ring," the caller will hear that MoH instead of ringing while they are waiting for someone to pick up.
CID Name Prefix
Optional - You can optionally prefix the Caller ID name when ringing extensions in this group. For example, if you prefix with "Sales:", a call from John Doe would display as "Sales:John Doe" on the find me / follow me list extensions that ring.
Alert Info
Optional - You can optionally include an Alert Info, which can create distinctive rings on SIP phones.
Call Confirmation Configuration
Confirm Calls
Yes/No: Whether to confirm external calls. Call confirmation requires the remote party to press 1 to accept the call. This can help prevent an unanswered find me / follow me call from reaching an external voicemail box. This feature only works with the ringall or ringall-prim ring strategies.
Remote Announce
Message to be played to the person receiving the call if Confirm Calls = Yes. You can use the default message or select one of your System Recordings.
Too-Late Announce
Message to be played to the person receiving the call if Confirm Calls = Yes and the call has already been accepted elsewhere.
Change External CID Configuration
Mode
Default: Transmits the caller's CID if allowed by the trunk.
Fixed CID Value: Always transmit the Fixed CID Value below.
Outside Calls Fixed CID Value: Transmit the Fixed CID Value below on calls that come in from outside only. Internal extension-to-extension calls will continue to operate in default mode.
Use Dialed Number: Transmit the number that was dialed as the CID for calls coming from outside. Internal extension-to-extension calls will continue to operate in default mode. There must be a DID on the inbound route for this. This will be BLOCKED on trunks that block foreign CallerID.
Force Dialed Number: Transmit the number that was dialed as the CID for calls coming from outside. Internal extension-to-extension calls will continue to operate in default mode. There must be a DID on the inbound route for this. This WILL be transmitted on trunks that block foreign CallerID.
Fixed CID Value
Fixed value to replace the CID used with some of the modes above. Should be in a format of digits only with an option of E164 format using a leading "+".
Destinations
No Answer
Optional destination call is routed to when the call is not answered on an otherwise idle phone. If the phone is in use and the call is simply ignored, then the busy destination will be used.
Advanced
Click on the Advanced tab.
There are many settings in this tab. See below for explanations of the options.
Assigned DID/CID
DID Description
A description for this DID, such as "Fax"
Add Inbound DID
A DID that is directly associated with this extension. The DID should be in the same format as provided by the provider (e.g. full number, 4 digits for 10x4, etc). Format should be: XXXXXXXXXX
Add Inbound CID
Add a CID for more specific DID + CID routing. A DID must be specified in the above Add Inbound DID field. In addition to standard dial sequences, you can also enter Private, Blocked, Unknown, Restricted, Anonymous, Withheld, and Unavailable in order to catch these special cases if the Telco transmits them.
Call Camp-On Services
Caller Policy
Asterisk: cc_agent_policy. Used to enable Camp-On for this user and set the technology mode that will be used when engaging the feature. In most cases Generic Device should be chosen unless your phones are designed to work with channel-specific capabilities.
Callee Policy
Asterisk: cc_monitor_policy. Used to control whether other phones are allowed to Camp On to this extension. If so, it sets the technology mode used to monitor the availability of the extension. If no specific technology support is available, then it should be set to a Generic Device. In this mode, a callback will be initiated to this extension when it changes from an InUse state to NotInUse. If it was busy when first attempted, this will be when the current call has ended. If it simply did not answer, then this will be the next time this phone is used to make or answer a call and then hangs up. It is possible to set this to take advantage of Native Technology Support if available and automatically fall back to the Generic Mode if not.
Add Extension
channel
The DAHDi channel number for this port.
context
Asterisk context this device will send calls to. Only change this is you know what you are doing.
immediate
DAHDi immediate mode setting, see DAHDi documentation for details.
signalling
DAHDi signalling, usually fxo_ks when connected to an analog phone. Some special applications or channel bank connections may require fxs_ks or other valid settings. See DAHDi and card documentation for details.
echocancel
DAHDi echocancel setting, see DAHDi documentation for details.
echocancelwhenbridged
Whether to turn on echo cancellation when bridging between DAHDi channels. See DAHDi documentation for details.
echotraining
Echo training requirements of this card. See DAHDi documentation for details.
busydetect
Experimental and un-reliable setting to try and detect a busy signal. See DAHDi documentation for details.
busycount
Experimental and un-reliable setting to try and detect a busy signal, number of iterations to conclude busy. See DAHDi documentation for details.
callprogress
Experimental and un-reliable setting to try and detect call progress tones. See DAHDi documentation for details.
dial
How to dial this device. This should not be changed unless you know what you are doing.
accountcode
Account code for this device.
callgroup
Callgroup(s) that this device is part of. Can be one or more callgroups, e.g. "1,3-5" would be in groups 1,3,4,5.
pickupgroup
Pickupgroups(s) that this device can pickup calls from. Can be one or more groups, e.g. '1,3-5' would be in groups 1,3,4,5. Device does not have to be in a group to be able to pick up calls from that group.
mailbox
Mailbox for this device. This should not be changed unless you know what you are doing. This will be automatically set to: <extnum>@device
With an LDAP backend, to enable MWI (Message waiting indication), enter a semi-colon list of mailboxes in the form <extnum>@default
e.g. 101@default;102@default ...where the message lamp will light if any of the specified mailboxes has unread mail
CID Num Alias
The CID Number to use for internal calls, if different from the extension number. This is used to masquerade as a different user. A common example is a team of support people who would like their internal CallerID to display the general support number (a ringgroup or queue). There will be no effect on external calls.
SIP Alias
If you want to support direct sip dialing of users internally or through anonymous sip calls, you can supply a friendly name that can be used in addition to the users extension to call them.
Extension Options
Asterisk Dial Options
Cryptic Asterisk Dial Options. Check the override box to customize for this extension, or un-check to use system defaults set in Advanced Options. These will not apply to trunk options, which are configured with the trunk.
Ring Time
Number of seconds to ring prior to going to the "no answer" destination. Default will use the global default value set in Advanced Settings. If no voicemail is configured this will be ignored.
Call Forward Ring Time
Number of seconds to ring during a Call Forward, Call Forward Busy or Call Forward Unavailable call prior to continuing to voicemail or specified destination. Setting to Always will cause the phone to just continue to ring without going to the "no answer" destination. Default will use the current Ring Time. If voicemail is disabled and a destination is not specified, it will be forced into Always mode.
Outbound Concurrency Limit
Maximum number of outbound simultaneous calls that an extension can make. This is also very useful as a security protection against a system that has been compromised. It will limit the number of simultaneous calls that can be made on the compromised extension.
Call Waiting
Enable/Disable: Set the initial/current Call Waiting state for this user's extension. If disabled, a second concurrent incoming call would be sent to this extension's "busy" destination.
Internal Auto Answer
Disable/Intercom: When set to Intercom, calls to this extension/user from other internal users act as if they were intercom calls meaning they will be auto-answered if the endpoint supports this feature and the system is configured to operate in this mode. All the normal white list and black list settings will be honored if they are set. External calls will still ring as normal, as will certain other circumstances such as blind transfers and when a Follow Me is configured and enabled. If Disabled, the phone rings as a normal phone.
Call Screening
Call Screening requires external callers to say their name, which will be played back to the user and allow the user to accept or reject the call. Screening with memory only verifies a caller for their CallerID once. Screening without memory always requires a caller to say their name. Either mode will always announce the caller based on the last introduction saved with that CallerID. If any user on the system uses the memory option, when that user is called, the caller will be required to re-introduce themselves and all users on the system will have that new introduction associated with the caller's CallerID.
Pinless Dialing
Enabling Pinless Dialing will allow this extension to bypass any PIN codes normally required on outbound calls.
Emergency CID
This Caller ID will always be used when dialing out an Outbound Route that is designated as an "Emergency" route (i.e. when dialing 911). The Emergency CID overrides all other CallerID settings.
Queue State Detection
If this extension is part of a queue, then the queue will attempt to use the user's extension state or device state information when determining if this queue member should be called. In some uncommon situations, such as a Follow-Me with no physical device, or some virtual extension scenarios, the state information will indicate that this member is not available even when it is available. Setting this to Ignore State will make the queue ignore all state information, thus always trying to contact this member. Certain side effects can occur when this route is taken due to the nature of how queues handle local channels. For example, subsequent transfers will continue to show the member as busy until the original call is terminated. In most cases, this should be set to Use State.
Recording Options
Inbound External Calls
Force/Yes/Don't Care/No/Never: Recording of inbound calls from external sources.
Outbound External Calls
Force/Yes/Don't Care/No/Never: Recording of outbound calls to external sources.
Inbound Internal Calls
Force/Yes/Don't Care/No/Never: Recording of calls received from other extensions on the system.
Outbound Internal Calls
Recording of calls made to other extensions on the system.
On Demand Recording
Disable/Enable/Override: Enable or disable the ability to do on demand (one-touch) recording. The overall calling policy rules still apply, and if calls are already being recorded by "Force" or "Never," the cannot be paused unless "Override" is selected.
Record Priority Policy
This is the call recording policy priority relative to other extensions when there is a conflict (i.e. one extension wants to record and the other extension does not). The higher of the two priorities determines the policy. If the two priorities are equal, the global policy (caller or callee) determines the policy.
Dictation Services
Dictation Service
Disabled/Enabled: Whether Dictation service is available for this extension.
Dictation Format
Audio format to use for dictation (Ogg Vorbis, GSM, or WAV).
Email Address
The email address that completed dictations are sent to.
From Address
The email address that completed dictations are sent from. Format is "A Persons Name <email@address.com>", without quotes, or just a plain email address.
DTLS
(Datagram Transport Layer Security)
Enable DTLS
No/Yes: Enable or disable DTLS-SRTP support.
Use Certificate
The Certificate to use from Certificate Manager
DTLS Verify
Verify that provided peer certificate and fingerprint are valid.
Yes: Perform both certificate and fingerprint verification
No: Perform no certificate or fingerprint verification
Fingerprint: Perform ONLY fingerprint verification
Certificate: Perform ONLY certificate verification
DTLS Setup
Whether we are willing to accept connections, connect to the other party, or both. This value will be used in the outgoing SDP when offering and for incoming SDP offers when the remote party sends actpass
Active: we want to connect to the other party
Passive: we want to accept connections only
Act/Pass: we will do both
DTLS Rekey Interval
Interval at which to renegotiate the TLS session and rekey the SRTP session. If this is not set or the value provided is 0 rekeying will be disabled.
Optional Destinations
No Answer
Optional destination call is routed to when the call is not answered on an otherwise idle phone. If the phone is in use and the call is simply ignored, then the busy destination will be used instead.
CID Prefix
Optional CID Prefix to add before sending to this no answer destination.
Busy
Optional destination the call is routed to when the phone is busy or the call is rejected by the user. This destination is also used on an unanswered call if the phone is in use and the user chooses not to pick up the second call.
CID Prefix
Optional CID Prefix to add before sending to this busy destination.
Not Reachable
Optional destination the call is routed to when the phone is offline, such as a softphone currently off or a phone unplugged.
CID Prefix
Optional CID Prefix to add before sending to this not reachable destination.
Other
Endpoint
Brand
Brand of device to be provisioned
MAC
MAC Address of device to be provisioned
Template
Template to use for device
Model
Model of device to be provisioned
Account
Account number to be assigned
iSymphony Settings
Add to iSymphony
yes/no: Whether to Makes this extension available in iSymphony
Auto Answer
yes/no: Whether to make this extension automatically answer the initial call received from the system when performing an origination within iSymphony. Only works with Aastra, Grandstream, Linksys, Polycom, and Snom phones.
Device Options
Channel
Choose the FXS channel for this extension
Parkinglot
Choose a default Parking Lot for this extension.
Language
Language Code
This will cause all messages and voice prompts to use the selected language if installed. Languages can be added or removed in the Sound Languages module.
Default Group Inclusion
Default Page Group
Exclude/Include: Whether this extension/device will be part of the default page group.
Default VMblast Group
Exclude/Include: Whether this extension/device will be part of the default voicemail blast group. Include will be ignored if the user does not have a voicemail box.
Saving the Extension
Click the Submit button
Click the Apply Config button