Manual Dialplan Configuration

From Taridium

Latest revision as of 19:17, 17 June 2010

Most applications and ipbx functions are usually accessed using the pre-built dialplan (inside.ipbx), but it is also possible to call IVR, Groups, Conference Rooms etc. directly using a variety of AGI (Asterisk Gateway Interface) scripts.

This allows you to write complex diaplans while still retaining the GUI functionality for individual applications.

The ipbx Dialplan can be access via Configuration → Manual Editor → Dialplan.

The dialplan and other manual configuration elements can be either edited completely or in sections. Although Ipbx uses realtime database queries to route calls in most cases, changes in the Manual Editor need to be loaded manually. Always remember to have the reload configuration upon update ticked if you want to activate your manual configuration changes immediately. This is the default behavior.

Application Launcher Script

The application launcher script allows you to access the main applications directly using common Asterisk AGI compatible syntax.

The applications.ipbx script takes the following two arguments:

1. [application name] (required)

can be any of the following: ivr, conf, queue, channel, group or starcode.

2. [application ID] (required)

is usually the name of the application element being called.

3. [application parameter] (optional)

Example calling an IVR named ivrtest

 exten => 9000,1,agi(ipbx/applications.ipbx,ivr,ivrtest)

Using Manually mapped Star Code Features

When using the starcode application, you can use the following star code names:

• voicemailaccess
• forwardtoggle
• voicemailtoggle
• blocktoggle
• followmetoggle
• datetime
• parkcall
• echotest
• mohdefault
• serviceivr
• oncallswitch

The following star code names require a further parameter to be passed along (see 3. application parameter)

• pickupparkedcall
• personalconf
• ivrswitch
• paging
• delayedpaging
• spychan
• whisperchan
• pickup

Example calling star code to pickup a ringing extension

 exten => _*56XXXX,1,agi(ipbx/applications.ipbx,starcode,pickup,${EXTEN:3})

Note that you will have to pass the application parameter on its own ${EXTEN:3}. For further details on built-in Features see Feature Map.

Standard Extension Script

The standard extension script can be used to ring a user using all the various feature settings. The script can be called without any arguments and will try to derive the called user from the extension called. This is the same extension logic as if you were to select an user to be called in any GUI configuration element.

The stdexten.agi script takes the following optional arguments:

1. [override technology]

Set this to SIP or IAX if you need to change the used technology

2. [override channel]

Set a different main ring channel than specified in the user settings

3. [dial arguments]

Add dial arguments to be passed to the Dial Application

4. [voicemail mailbox]

Set a different mailbox/user than the one derived from the extension called. This is part of the unique user identifier.

5. [voicemail context]

Set a different context than the one derived from the extension called (usually default). This is part of the unique user identifier.

Example calling user at extension 4001

 exten => 4001,1,agi(ipbx/stdexten.agi)