Modules

From Askozia Handbook
Jump to: navigation, search


The Call Flow Editor offers about sixty different modules. They are organized in five categories: Basic, Playback, Call flow, Record and Complex. To see all available Modules, switch from Basic Mode to Advanced Mode in the upper part of the navigation as shown in First steps within the Call Flow Editor.


Contents

Basic

The Basic category includes all modules necessary for basic call flows and basic call handling. These modules allow to answer calls, forward calls to voicemail, control the maximum number of parallel calls and call queues.

Basic modules

The chapter follows the order of modules as used in the Call Flow Editor.


Start

Askozia CFE start.png

This module is essential for every call flow. A call flow always has to start with Start, usually followed by an Answer module.

The Basic call handling template gives a first example of how to make a phone available within a call flow, including the Start, Answer, Extension and Hangup modules.



Answer

Askozia CFE answer.png

To initialize further call handling, the Start module needs to be followed by an Answer module. A delay can be specified in seconds. If a delay is specified, the call flow will wait the specified number of seconds after answering the call, before continuing with the call flow. Use a Wait module prior to Answer to add a delay prior answering.

The Basic call handling template gives a first example of how to make a phone available within a call flow, including the Start, Answer, Extension and Hangup modules.



Hangup

Askozia CFE hangup.png

The Hangup module hangs up the calling channel unconditionally and marks a possible end of the call flow. There can be more than one Hangup, since a call flow can have more than one end.

However, using Hangup is optional because Asterisk automatically terminates calls. It's main purpose is to give users a better overview by marking where a call flow ends.

The following templates give examples of using Hangup multiple times in a call flow.



SoftHangup

Askozia CFE softhangup.png

SoftHangup tries to hang up all calls on the current channel, in order to make the channel available for another call. This module can be used to drop calls when a high priority call comes in. On a ship you might call this 'captain feature'.



CallerID

Askozia CFE callerid.png

CallerID can manipulate the caller IDs of incoming calls. Caller IDs are expanded with the numbers or Asterisk variables entered in the text field of the module. Clicking on Askozia options.png provides further configuration options. “Prepend to existing name” and “Append to existing name” define where the changes are added. If none of these options is selected, the CallerID is completely replaced.



CallerID Name

Askozia CFE callerid name.png

CallerID Name can manipulate the caller IDs of incoming calls. Caller IDs are expanded with the letters or Asterisk variables entered in the text field of the module. Clicking on Askozia options.png provides further configuration options. “Prepend to existing name” and “Append to existing name” define where the changes are added. If none of these options is selected, the CallerID is completely replaced.



Extension

Askozia CFE extension.png

The Extension module attempts to establish a new connection to the phone selected in the drop-down menu, and then connect the phone to the existing call flow. Beside your internal and external phones, all faxes and call groups can be selected too.

The Basic call handling template gives a first example of how to make a phone available within a call flow, including the Start, Answer, Extension and Hangup modules.

Clicking on Askozia options.png allows further configuration options.

Extension options

The default timeout is ten seconds. If the phone isn't answered within the specified timeout period, the channel signals 'busy'.

Additionally, permissions can be set for call transfers, Music-on-Hold (MOH) and call recording.

To not show missed calls on the phone display, please check Don't show missed calls on phone

Click Save and Close to finish the configuration.



DialNumber

Askozia CFE dialnumber.png

DialNumber attempts to establish a new connection to an arbitrary phone number and then connects it to the call flow. Enter the number to be called.

Additionally, the context of this module has to be selected out of these four options:

  • only internal phones only allows internal phones to be called.
  • all internal numbers includes phones, faxes, call groups and applications.
  • external calls only allows to call external numbers.
  • internal and external numbers allows all internal and external numbers.

The following templates give examples of using DialNumber.



Music on Hold

Askozia CFE MoH.png

The MoH (Music on Hold) module allows you to use multiple waiting music tracks within one call flow. When passing through the MoH module within a call flow, the uploaded track is being played whenever Music on Hold is used (e.g. in queues, transfers, etc.) until either the call flow ends or another MoH module with a different track is passed.



Voicemail

Askozia CFE voicemail.png

Leave a voicemail in the inbox of the selected phone. If you want the caller to hear your entire phone number, define it as External Number. If you don't define an external number, your internal extension is read back to the caller.

Clicking on Askozia options.png allows further configuration options.

Voicemail options

The voicemail instruction message can be deactivated and/or the unavailable message or the busy message can be activated.

Click Save and Close to finish the configuration.

The Basic If example and Basic language selector templates show examples of use.



WebIntegration

Askozia CFE webintegration.png

The WebIntegration module is part of Web Integration Tool (WIT) software add-on for AskoziaPBX. It requires the WIT browser plug-in to be installed and enables notifications about incoming calls for one or more users.

Learn more about the WebIntegration module in the Web Integration Tool chapter.



MaximumCalls

Askozia CFE maximumcalls.png

This module limits the number of simultaneous calls. As long as the specified maximum number of simultaneous calls is not exceeded, the call flow follows the green label. If the specified maximum number of simultaneous calls is reached, all new calls will follow the red label.

An example for using this module, is the Limit number of simultaneous calls template.



Time Switch

Askozia CFE timeswitch.png

Time Switch allows to make parts of a call flow active for certain time windows during a day or for several days of the week. It allows alternative call handling for calls incoming outside the specified time windows. This is very useful to treat calls differently outside business hours.

Clicking on Askozia options.png allows further configuration options.

Time Switch options

First, the time intervals where the time switch should be active have to be specified. During the specified time windows, the call flow follows the green label. If callers call outside of the specified time windows, the call flow follows the red label.

Click Save and Close to finish the configuration.

The Basic time switch example template provides an example.


Calendar

Askozia CFE Calendar.png

More information will follow. Please see the video below.


Email

Askozia CFE email.png

The Email module sends an email to the specified email adress.

Clicking on Askozia options.png allows further configuration options.

Email options

The subject and the text of the email have to be specified as well. Furthermore, the caller ID, time and date as well as the call length can be added to the email. The call length states for how long a caller was within the call flow.

Click Save and Close to finish the configuration.



Authenticate

Askozia CFE authenticate.png

When the call flow reaches Authenticate, the caller has to enter the specified passcode before continuing.

An example of use is available in the Direct Inward System Access (DISA) template.



Queue

Askozia CFE queue.png

Queue allows to create an Automatic Call Distribution (ACD) queue and define ring mode, global timeout, announcement frequency, wrap-up time and try interval.

Queues mainly consist of incoming calls being placed in the queue and members (agents) that answer the queue. It comes along with a strategy on how to handle calls and how to distribute calls between members, Music-on-Hold (MOH) as well as announcements for callers.

An announcement for callers can be recorded by clicking the Record now button of the Queue module. Alternatively, an audio file can be uploaded by clicking on its Upload File button.

For adding agents to the Queue module, connect QueueMember modules or use the queue's Agent Login. Furthermore, you can define after how many seconds a timeout is reached. For this purpose, a time-out path is added to a Queue module by adding one module, or sequence of modules, that is not a QueueMember module.

The Basic Queue example template offers a basic example of how to use the Queue and QueueMember modules as well as a time-out path leading to a Busy module.

The following video shows how to create an ACD queue by using Queue and QueueMember modules.

Clicking on Askozia options.png allows further configuration options as well as access to the Wallboard.

Queue type defines the ring mode of the queue. Incoming calls are distributed following the chosen strategy. The following queue types are available:

  • Ring all phones rings all free phones simultaneously.
  • Ring phone least recently called rings the phone which was called least recently and is free.
  • Ring phone with fewest calls always calls the agent who answered the least calls.
  • Ring a random phone rings a random phone each time.
  • Ring one after another always starts with the QueueMember modules following the order they have been added and continues with the agents logged in with Agent Login following the order they logged in.
  • Round robin with memory, remember where we left off last ring pass calls the last phone that was ringing and continues with the other agents one after another as long as the call is not answered.

A Name can be defined for reference, such as for the Queue Statistics), but will not be parsed.

Specify the following time intervals to control the queue:

  • Timeout (sec.) specifies the period of time before the call is dropped or forwarded to the time-out path. The default value is 600 seconds.
  • Announce (sec.) is the period of time after which the uploaded announcement should be repeated. The default value is 20 seconds.
  • Wrapup (sec.) is the time period members have before they receive the next call. The default value is 30 seconds.
  • Interval (sec.) is the time period of a member's phone ringing before the call is forwarded to the next phone. The default value is 10 seconds.
Queue options
  • Ring instead of playing MOH: Instead of playing Music-on-Hold (MOH), the caller can hear the ringing signal.
  • Stop MOH and ring once an agent is ringing: Use Music-on-Hold, but let the music stop and ring instead as soon as an agent's phone is ringing.
  • Don't ring when agent is already on announcement: An agent won't get a call waiting notification when already answering another call.
  • Caller: Join empty queue: The caller can enter a queue even if no agent is logged in.
  • Caller: Leave when queue is empty: All callers are dismissed from the queue, when the last agent is logged out.
  • Announce estimated hold time: A notification for the average hold time. This message will be played, when the average hold time is longer than two minutes.
  • Announce queue position: A notification to the caller, informing him about the current position within the queue.
  • Show missed calls on phone: If a caller hangs up before the call is answered, all agents receive a missed call notification.

Announce frequency specifies how frequently activated estimated hold time or queue position announcements are played to the caller. The default value is 30 seconds.

Agent Login and Wallboard are described in the following subsections. Click on Show wallboard to see the queue's statistics.

To finish the configuration, click Save and Close.

Time-out path

Add a time-out path to a Queue module by adding one module that is not a QueueMember module. The call flow designer has a wide variety of choices here, including among others Busy tone playback, Voicemail or Email. Alternatively, a more complex timeout path can be added, such as another queue or an interactive voice response (IVR) menu by adding a PressExtension or PressExtensionMusic module, or other individual scenarios, for example including If or Switch modules. In any way, only one single time-out path is allowed for each Queue module module. The call flow will follow this path in case the time-out is exceeded for a caller that is still waiting.

The Basic Queue example template offers a basic example of how to use the Queue and QueueMember modules as well as a time-out path leading to a Busy module.


Agent login

Additionally or as an alternative to the static QueueMember modules, agent login for this queue can be activated. It allows flexible sign in and sign out for agents. To sign in or out, members just have to dial the Login number followed by their own internal extension as well as the specified Login PIN. Agents can add the Login number to their Speed Dial buttons if supported by their phones. More information about Speed Dial can be found in the auto-configuration section of the phone account.

The following video provides a tutorial about how to use Queue, QueueMember and the Agent Login.



To finish the configuration, click Save and Close.


Entering call queue depending on agent status

To ensure that no calls enter a queue when no agent is logged in, follow these steps.

1. Open the desired Call Flow and press ctrl + D to open the information window.

Information window

2. The red marked area includes the ID of the queue in the Call Flow.

3. Place an If-Manually before the Queue and enter the following command.


QUEUE_MEMBER_COUNT(ENTER_HERE_YOUR_QUEUE_ID)

< Less

1
Exaple query for agent login status

This command checks, if one or more agents are logged in in the queue. If not, the green path is used and leads to an alternative destination. If an agent is logged in, the red path will be followed and leads into the queue.


Wallboard

Each Queue module provides a Wallboard. This is a website with real time statistics for each call queue. The website can be displayed on a screen, for example in a call center. Additionally, the Queue Statistics can be exported as CSV files and further processed with any spreadsheet program (e.g. LibreOffice). For saving the statistics, go to Status within the AskoziaPBX web interface and click on Call Detail Records.

To access the Wallboard, username and password for the statistic user have to be specified in General Setup. If an admin user accesses a Wallboard, the following message appears.

Wallboard, message for admin users
Wallboard

The Wallboard shows all agents on call, waiting calls and missed calls in real time. It also shows the current caller and talking time for each agent, the current waiting time of waiting calls and how long ago each missed call appeared. Additionally, it shows the amount of answered calls, as well as the average hold time and the average talk time.

A configuration menu is located at the bottom side of the window, allowing the following parameters to be set.

  • Font size
  • Refresh time is useful if the machine you´re running the PBX on has not much CPU power.
  • Remove missed calls is also useful to save CPU power.
  • Show logged in agents
  • Reset resets the Wallboard statistics.
  • Remove this toolbar hides or shows the toolbar.

The video provides showing how to use the Wallboard and the Statistic User Login.

This video shows the usage of the menu at the Wallboard.

In order to customise the Wallboard with your company logo, please follow the steps below. Note that this should be done by advanced users only.

1. Create the "custom" folder on Askozia's storage disk. (e.g. /storage/usbdisk1/askoziapbx/custom/).

2. Name your logo file "logo_cfe.png" and copy this file into the "custom" folder.

3. Reboot the system.

During reboot, AskoziaPBX will recognise the new file. After the reboot, the logo file will have disappeared from the folder. For optimal results, your logo file should have 179 x 55 pixels. Please also make sure that it is a .png file.

The same workflow can be applied to customise the logo of the Call Detail Records. For this, a file named "logo_cdr.png" needs to be uploaded into the "custom" folder (the optimum size is 1316 x 401 pixels). Reboot AskoziaPBX to apply the changes.

To return to the default logos, create an empty file in the "custom" folder and name the file "remove". After a reboot, the logos are set back to default.



QueueMember

Askozia CFE queuemember.png

QueueMember always has to be used with the Queue module. Select one of the already configured phone accounts to connect it with a Queue module and use it as an agent.

Clicking on Askozia options.png allows further configuration options.

QueueMember options

The called user as well as the calling user can be allowed to transfer the call. Click Save and Close to finish the configuration.

The Basic Queue example shows how to use the Queue and QueueMember modules.



Transfer

Askozia CFE transfer.png

Transfer allows you to transfer calls to another internal phone. Select the already configured phone you want to transfer to.

Contrary to the Extension module, Transfer allows internal phones but no external phones, fax or call group extensions.

Please note that the channel is terminated when using Transfer. Therefore, no calls are possible on this channel afterwards. For example, using Email is still possible. If you don't want the channel to be terminated, use Extension instead.



Wait

Askozia CFE wait.png

Wait integrates a waiting period for the specified amount of seconds before continuing with the next module.

During the time waited, all sound input received on the channel, including DTMF tones, are ignored. As an example, Wait might be used before answering a channel.



WaitForSilence

Askozia CFE waitforsilence.png

WaitForSilence waits for a period of silence specified in the Interval parameter. This module is useful to detect the starting point for Playback when leaving a voice message.

The Timeout parameter should be specified to avoid an infinite loop in case silence is never achieved. Use it with caution, as it may defeat the purpose of this module.

The Retry parameter specifies how often the module should retry to achieve for a period of silence.



WaitMusicOnHold

Askozia CFE waitmusiconhold.png

WaitMusicOnHold plays Music-on-Hold for the specified number of seconds.



ChanIsAvailable

Askozia CFE chanisavailable.png

ChanIsAvailable checks if the selected IP phone is available or not. This module is usually used prior If or Switch modules to provide them input.

See an example of use in the Example with ChanIsAvailable and Switch template.



Askozia

Askozia CFE askozia.png

This module plays the Askozia tone to the caller.



Note

Askozia CFE note.png

Use this module to take notes and stick them to a call flow. This module does not have any influence on the call flow's functionality.



Playback

The Playback category provides all modules for implementing text-to-speech engines as well as playback of sounds and files.

Playback modules

The chapter follows the order of modules as used in the Call Flow Editor.


Ringing

Askozia CFE ringing.png

Ringing plays the ringing tone to the caller on an answered channel. It continues immediately with the next step in the call flow. Specify a timeout to let the user hear a ringing for a certain period.


Text2Speech

Askozia CFE text2speech.png

Text2Speech implements a runtime speech synthesis engine. Specify the text in the module's text box. The module will read back the entered text to the caller.

The following templates give examples of how to use Text2Speech.



SayDigits

Askozia CFE saydigits.png

SayDigits returns the entered digits one by one. Enter the desired digits in the module's text field. Combining SayDigits with Set Language returns the digits in the selected language.

Examples are provided by the Example with Read and SayDigits and Example with Read, SetLanguage and SayDigits templates.



Playback

Askozia CFE playback.png

The Playback module plays a file or recording, such as a welcome message.

After selecting a phone and clicking Record now, the selected phone will be called and a message can be recorded. When done with recording, press the '#' button of the phone and the recording will be saved. Alternatively, upload a file by clicking on Upload.

As a third option, an extension is assigned to every new Playback module. This number can be written down and called in order to call the respective Playback module and directly record a message. When calling the Playback module, wait for the signal tone to start recording. Finish your recording by pressing the '#' key on your phone.

Either way, Playback will play the whole file or record and afterwards return to the call flow to continue.

The Redirect with welcome message template provides an example.



Playtones

Askozia CFE playtones.png

Playtones allows to select a tone to be played to the caller. The list of available tones depends on the country-specific tone scheme selected in the Regional Settings. To stop playing a tone started by Playtones, use StopPlaytones.



StopPlaytones

Askozia CFE stopplaytones.png

StopPlaytones stops playing the tone started by Playtones.



Busy

Askozia CFE busy.png

The Busy module plays a busy tone for the specified amount of seconds and allows the call flow to continue afterwards, for example to be followed by a Hangup module.

Examples for using Busy are given in the following templates.




Congestion

Askozia CFE congestion.png

This module plays the congestion tone to the caller for the specified amount of seconds and allows the call flow to continue afterwards, for example to be followed by a Hangup module.



Echo

Askozia CFE echo.png

This module echos audio and video back to the caller as soon as it is received. Echo is usually used to test connection delays.



Milliwatt

Askozia CFE milliwatt.png

Milliwatt generates a constant 1004 Hz tone and is usually used for testing the connection quality.



Call Flow

The modules of the Call Flow category allow further call handling by integrating If or Switch modules for specifying and handling conditions, Goto modules, and Interactive Voice Response (IVR) scenarios by integrating PressExtension or PressExtensionMusic modules.

Call Flow modules

The chapter follows the order of modules as used in the Call Flow Editor.


If

Askozia CFE if.png

The If module allows to specify a condition by selecting a variable and provides two possible outcomes.

The call flow follows the green label if the condition is true, and follows the red label if the condition is false. Input variables can be given by connecting the If module to an Extension, Voicemail, Transfer, Queue or ChanIsAvailable module. Select the desired condition variable from the first drop down menu and specify the operator as well as the condition. If an Asterisk variable should be used but is not available in the drop down menu, use the IfManually module instead.

For realizing time based conditions, use Time Switch instead. For realizing conditions based on maximum parallel calls, use MaximumCalls instead.

The Fallback to Queue and Basic If example templates provide examples of using the If module.



Path Switch

Askozia CFE path switch.png

With the Path Switch module you can activate and deactivate parts of a call flow by calling the number of the path switch module or button press on your phone. The path switch module is for example useful if you want to manually switch between different voicemail boxes.

In the basic setup the module is inactive, which means by default the red path is used. If you put the path switch number on a BLF (busy lamp field on your phone) the light is off. By pressing the BLF (or dialling the number of the path switch module) the green path is used. Depending on the phone you are using, the BLF should be on now.

By clicking on Askozia options.png, you can define a PIN code for this path switch to prevent unauthorised usage or execute Asterisk Dial Plan commands. Please note that these commands are execute when the module is switched and not when a call passes through this module. Click save to finish the configuration.


Chief-Secretary feature

The chief-secretary function allows to route incoming calls for one number, either to one phone or to another, by pressing a BLF. This feature often is used when a college doesn’t want to be disturbed without setting a forwarding. Both parties are able to switch the path of the call flow and the status of the path switch is illuminated via BLF.

To realize this scenario, the following call flow can be used. The number of the path switch module can be set into a BLF on both phones. By pressing the BLF, both parties can switch the module and manipulate the path of the call flow.

Chief-secretary feature



IfManually

Askozia CFE ifmanually.png

IfManually is an alternative to If in case an Asterisk variable should be used but is not available in the drop down menu. It allows to specify a condition by entering a variable and provides two possible outcomes.

The call flow follows the green label if the condition is true, and follows the red label is the condition is false. Input variables can be given by connecting IfManually to an Extension, Voicemail, Transfer, Queue or ChanIsAvailable module. Use any Asterisk variable to create conditions (e.g. DIALSTATUS). You don't need to enclose the variable in dollar signs and curly braces.



Switch

Askozia CFE switch.png

Switch allows to specify up to four conditions at the same time.

The call flow will follow the outgoing label related to the first condition to be true. If none of the conditions is to be true, the call flow will follow the default label.

Each Switch module needs to be filled with data before it can be used. Inputs can be given by connecting the Switch module to an Extension, Voicemail, Transfer, Queue or ChanIsAvailable module. Select the desired condition variable from the first drop down menu and specify the conditions using the drop down menus following below. If an Asterisk variable should be used but is not available in the drop down menus, the SwitchManually module may be used instead.

The Example with ChanIsAvailable and Switch template gives an example of use.



SwitchManually

Askozia CFE switchmanually.png

SwitchManually is an alternative to Switch in case an Asterisk variable should be used but is not available in the drop down menu. It allows to specify up to four conditions at the same time.

The call flow will follow the outgoing label related to the first condition to be true. If none of the conditions is to be true, the call flow will follow the default label.

Inputs can be given by connecting SwitchManually to an Extension, Voicemail, Transfer, Queue or ChanIsAvailable module. Use any Asterisk variable to create conditions (e.g. DIALSTATUS). You don't need to enclose the variable in dollar signs and curly braces.



Goto

Askozia CFE goto.png

Goto sends the call flow to the specified module, e.g. for creating a fallback to another module within the call flow.

Click on Goto destination and then click on the module the call flow is supposed to go to. The ID of the module will be saved by the Goto module. The module IDs depend on the order the modules have been added to the call flow. When the call flow reaches the Goto, it will be send directly to the specified module.

An example is given by the Example with ChanIsAvailable and Switch template.



SendDTMF

Askozia CFE senddtmf.png

This module plays arbitrary Dual-Tone Multi-Frequency (DTMF) tones to the caller. Enter the digits you wish to send. Entering a 'w' in between the digits will cause a pause of 0.5 seconds.



ExtensionH

Askozia CFE extension-h.png

ExtensionH stands for Hangup Extension. This module is used to clean up a call. It can be used to execute a part of the call flow after the called person has already hung up.



ExtensionI

Askozia CFE extension-i.png

ExtensionI stands for Invalid Extension. This module is used to handle an invalid extension dialed by the caller. For example, the IVR menu gives you the options to press '1', '2' or '3', but the user presses '4'. In this case the call flow follows the path of the ExtensionI module.

It can be integrated in an Interactive Voice Response (IVR) menu, following a PressExtensionMusic or PressExtension module.

The Basic IVR example and Basic IVR example with text to speech engine provide examples.



ExtensionT

Askozia CFE extension-t.png

ExtensionT stands for Timeout Extension. It handles time-outs whenever they occur. It can be integrated in an Interactive Voice Response (IVR) menu, following a PressExtensionMusic or PressExtension module.

An example is given in the Basic IVR example template.



ExtensionS

Askozia CFE extension-s.png

ExtensionS stands for Start Extension. The Start Extension can be used as a new start in the call flow. Callers are not supposed to go back further than to this point, unless they have passed through other functions.



PressExtensionMusic

Askozia CFE pressextensionmusic.png

This module is one of two possible starting points for implementing Interactive Voice Response (IVR) menus. At the same time it plays announcements to callers. The call flow continues with the module matching the extension pressed by the caller. Further information can be found in the PressExtension, Press1,…Press9, PressX, ExtensionI and ExtensionT sections.

Timeout specifies for how long the module waits for input of the caller. Connect ExtensionT to PressExtensionMusic to handle time-outs whenever they occur.

By pressing either the Record now or Upload file button, an announcement can be recorded or uploaded.

An example is given in the Basic IVR example template.

The following video shows how to create an IVR by using PressExtensionMusic.



PressExtension

Askozia CFE pressextension.png

This module is one of two possible starting points for implementing Interactive Voice Response (IVR) menus. The call flow continues with the module matching the extension pressed by the caller. Further information can be found in the PressExtensionMusic Press1,…Press9, PressX, ExtensionI and ExtensionT sections.

Timeout specifies for how long the module waits for input of the caller. Connect ExtensionT to PressExtension to handle time-outs whenever they occur.

If an announcement should be played, connect Playback prior to PressExtension or use PressExtensionMusic instead.

An example is given in Basic IVR example with text to speech engine.



Press1,…Press9

Askozia CFE numerical extensions.png

These nine modules can each be connected to a PressExtensionMusic or PressExtension module. The call flow continues with the module matching the extension pressed by the caller.

Examples are given in the Basic IVR example and Basic IVR example with text to speech engine templates.



PressX

Askozia CFE press-x.png

PressX allows to specify an individual extension for further use within an Interactive Voice Response (IVR). It can be connected to a PressExtension or PressExtensionMusic module. The call flow continues with this module if the extension pressed by the caller is matching the specified extension.



Record

The modules of the Record category allow call recording and sending recordings via email.

Record modules

The chapter follows the order of modules as used in the Call Flow Editor.

RecordEmail

Askozia CFE recordemail.png

RecordEmail is an alternative to Voicemail. The caller can leave a voice mail which is automatically to the specified email address. Use this module if you don't want to use the mailbox of an existing phone.

Clicking on Askozia options.png allows further configuration options.

RecordEmail options

Beside the caller's email address, the subject and the text of the email have to be specified. Beep tones can be deactivated. Select, if the message should already be recorded or be skipped if the line is not yet answered.

Click Save and Close to finish the configuration.

The Record a message and hang up template provides an example of use.



Monitor

Askozia CFE monitor.png

This module starts to record a phone call to a sound file.

After the call flow passes through, Monitor records the conversation. As soon as the call flow passes through the MonitorStop module, the recording is sent to the email address specified in MonitorStop.

An example is given by the Record phone calls and send via email template.



MonitorStop

Askozia CFE monitorstop.png

This module stops recording a telephone conversation started by Monitor. After hanging up, the recording is sent to the specified email address.

Clicking on Askozia options.png allows further configuration options.

MonitorStop options

Beside the caller's email address, the subject and the text of the email have to be specified. Click Save and Close to finish the configuration.

An example is given by the Record phone calls and send via email template.


Example for "Monitor Stop" with a prepend "ExtensionH"


MonitorPause

Askozia CFE monitorpause.png

MonitorPause pauses a call recording, previously started by Monitor. For unpausing a recording again, use MonitorUnpause.



MonitorUnpause

Askozia CFE monitorunpause.png

MonitorUnpause unpauses a call recording after it has been paused by MonitorPause.



Complex

The modules of the Complex category support language selection, creating variables from user input, executing Asterisk and Linux shell commands and giving access to Askozia's log entries.

Complex modules

The chapter follows the order of modules as used in the Call Flow Editor.


Set Language

Askozia CFE setlanguage.png

This module allows to change the default language of the call flow. Starting from this point, all standard voice prompts Askozia brings along will be played in the selected language.

Examples for integrating language selection are given in Basic language selector and Example with Read, SetLanguage and SayDigits



Read

Askozia CFE read.png

Read creates a variable based on digits from DTMF tones entered by the caller. Afterwards the variable can be used as input for other modules, for example DialNumber.

Specify the variable's name as well as the maximum number of digits to be accepted. The module stops reading after the maximum number of digits has been saved in the variable even if more digits are entered. Furthermore, the maximum number of attempts to enter digits as well as a timeout in seconds can be specified.

The following templates provide examples for using Read.



System

Askozia CFE system.png

Specify a Linux shell command to be executed by this module.



Command

Askozia CFE command.png

Specify an Asterisk command to be executed by this module.



Log

Askozia CFE log.png

The Log module allows to specify text and log level to be written in the phone system's log. 'ERROR', 'WARNING', 'NOTICE', 'DEBUG' or 'VERBOSE' can be selected as log level.



SQL

Askozia CFE sql.png

The SQL module allows to enter a MySQL database, when reached in the Call Flow.



URL

Askozia CFE url.png

The URL module opens an action URL, when passed in the Call Flow.


Personal tools
Namespaces

Variants
Actions
Navigation
Getting Started
AskoziaPBX
Call Flow Editor
UC Client
IX Interconnection
Web Integration Tool
CTI
PRI
Tools