Available Call Path/IVR Actions

Available Call Path/IVR Actions


Action

Description

Parameter 1

Parameter 2

ACD Group

Places incoming call in the queue for a specified team.

Team

Timeout Time

Agent Callin Login

An IVR containing only this action allows agents to dial in and register their device via phone by entering their extension.





AGI

Allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol on stand-in and stand-out.

Script to execute

----

Answer the call

Answer a channel if ringing





Background

Play the given list of files while waiting for an extension to be dialed by the calling channel.





Bridge

Bridges two channels via the dialplan. The current channel is connected to the specified channel.

Channel to be connected

----

Busy

Indicate Busy condition and wait for hang up





Campaign

Transfer call to specified campaign

Campaign name

Timeout time

Check Agents

Checks specified Team for the number of Agents Logged In (ALI) and Agents Ready (AR) and returns that data as variable ALI and AR

Team

-

Check Variable for Extension

Checks variable against list of existing extensions and routes call to the specified extension if able.

Variable



Conference

Establish a conference bridge

Conference number or name

----

Congestion

Indicated congestion and wait for hang up





Create Campaign Call

Marks the call as being for the specified Campaign.

Campaign



CustomDial

Attempts to dial on all specified channel (each specified by a type and identifier) simultaneously. First channel that answers “wins” and all others are hung up.

Channel

Time to wait for ring

Dial Extension with VM

Dials the specified Extension and will route to voicemail if voicemail is enabled and the call is not answered.

Extension

----

Dial Extensions without VM

Dials the specified Extension. Call will not route to voicemail if left unanswered.

Extension

----

Dial Outside Number

Places a call to specified phone number and bridges the existing call.

Phone Number

Timeout

Dial with confirmation

Places a call to specified phone number and bridges the existing call. Waits for an asterisk before dialing the specified number.
 Phone Number
 Timeout

Dial typed extension

Attempts to “dial out” on all specified channels

----

----

Directory

Provide directory of voicemail extensions

Dialplan segment

----

Disabled

Disable the given option

----

----

EAGI

See 'AGI'. Uses Enhanced AGI.

 Script to be Executed

EndWhile

Returns to the beginning of the active While() loop.



Fax2Email

Send a fax through email to the given parameter

----

----

Get Lead Info

Retrieves info about the lead. 



Go to beginning

Jump to beginning, extension, or context

----

----

Go to if Time

Check current time and compare to the specified Schedule. If the time falls within the Schedules range, the call will route to the specified IVR for the Schedule. Naming an IVR in Parameter 2 will override the IVR set for the Schedule.

Schedule

IVR

Go to Menu

Go to an IVR

IVR name

----

Goback

Return to previous IVR





GotoIF

Go to IVR if condition is true. Go to next step if false.

IVR name

Conditional Statement

Hangup

Hangs up a given channel

----

----

IsHuman

Ask if a Human is answering

IVR to jump to if Human

----

IsMachine

Ask if a Machine is answering

IVR to jump to if is Machine

----

Leave VM Message

Specified Audio File will play and will restart if audio is detected - aiming to have the full audio play after the answering machine's 'beep'

Audio File



Mix Monitor

Records the audio on the current channel to the specified file

File name?

----

Monitor

Record a telephone conversation to a sound file

----

----

Monitor an Extension

Record a telephone conversation to a sound file

Extension to Monitor

----

MySQL

Basic MYSQUL database functionality

Please refer to: http://www.voip-info.org/wiki/view/Asterisk+cmd+MYSQL

----

NoOP

No-operation; Does nothing; Can be used as a printf, or echo for the console

Text note

----

PaymentIVR

Call will route to hardcoded PaymentIVR if available (custom)

PaymentIVR



Play a File

Play a sound file

Sound file to play

----

Read into variable

Read a variable in the form of DTMF tones as pressed by the caller
 Recording to be played variable|max digits|max attempts| timeout (in seconds)

Read Keys

Read a variable in the form of DTMF tones as pressed by caller

Recording to be played

Number of digits to wait for

Read-Text2Speech

Read a variable in the form of DTMF tones as pressed by caller
 Text to be read out to the caller
 variable|max digits|max attempts| timeout (in seconds)

Record

Record a file

Name of the file to be recorded

----

Return

If the dial failed, this is the error message.

----

----

Ringing

Request that the channel indicated ringing tone to user

----

----

SayDigits

Reads a set of digits out to caller
 Digits

Send DTMF

Sends specified digits' DTMF tone(s) Digits

Send to Voicemail

Directory to send on voicemail

Voicemail Box Name

----

Send to Voicemail w/o intro

Sends call to specified voicemail box and skips the intro audio.
 Voicemail Box Name

Set

Set the value of channel variables or dialplan functions

Variable name

Variable value

Set Agent Disposition

Specifies a Call Result for the call. Note: if call is routed to an agent after this action, that agent’s call result will override the specified result.

Call Result



Set Call Result

Specifies a Call Result "Status" for a call (e.g. Person, Answering Machine, No Answer, etc.)
 Status

Set CallerID

Set CallerID on a call to a new value

Text String

----

Set Lead Info

Sets the value of the specified lead variable
 Variable
 Value

Start Full Call Recording

Starts recording the call

---

---

Start Recording

Starts recording the call

---

---

Text2Speech

Convert text to audio

Text string

----

Timeout

Sets timeouts on the channel

Time in sec.

----

VoiceMail Admin

Allows agents to call-in to their voicemail

--

---

Wait

Waits for a specified time

Wait time in sec.

----

Wait for Silence

Waits for up to 'silence required' milliseconds of silence

Wait time in millisec.

----

Webhook Expect Result

Custom Action for Client



Webhook Fire

Custom Action for Client



Webhook Set Formats

Custom Action for Client



Webhook Set Parameter

Custom Action for Client



Webhook Set URL

Custom Action for Client



While

Starts a While() loop

 Conditional Statement


Known Variables for [SET] action: 
stdagenttimeout - Timeout used when dialing an agent extension while the agent is logged in. If the agent is logged out, the device's "Ring Seconds" setting is used. 
QEBOX - Sets voicemail box that the call routes to when exiting the queue. Used when pressing a key to exit the queue.   
QEEXT - Sets an extension the call routes to when exiting the queue. Used when pressing a key to exit the queue. 
FAX_CLIENT - Sets Folder Name for Faxes
FAX_NOTIFICATION_EMAIL - List of emails that should receive notification of a received fax (separated by commas; 255 characters max)
IVR_NAME - Set's IVR Name for Fax Reporting
CALLERID - Sets the Caller ID for a call. Has primarily been used when transferring calls internally to include lead info (for that purpose, must be proceeded by a "Get Lead Info" action)


    • Related Articles

    • Routing: Call Paths/IVR

      IVR An IVR (Interactive Voice Response) is a technology that allows a computer to interact with humans through the use of voice and DTMF tones that are created/input through use of a keypad.  This section is used to manage IVRs.  Users can search by ...

    • How do I create a new IVR?

      Select the button labeled +add new IVR at the top of the Call Paths/IVRs submenu. Enter a new unique name for your new IVR and click submit. Next, you’ll need to create the sequence of actions to be used by your new IVR. Select +Add new step to add ...

    • Setting up Agent Call in Log in

      Setting up Agent Call in Log in Purpose: This article can be used to activate a third option for agents to connect to the Hosted Contact Center using any available telephone. When an agent logs into the HCC, a login screen displays the options of a ...

    • How to add Answering Machine Detection (AMD) to an Outbound IVR

      What is Answering Machine Detection? Intelligent Contacts' Hosted Contact Center Answering Machine Detection (AMD) service can determine if an outbound call was answered by a person or picked up by an answering or fax machine, and route the call ...

    • How do I add a new Phone Number?

      Select the button labeled +new phone number at the top of the Phone Numbers submenu (found under Routing). If you are using a virtual number, substitute a phone number for a new, unique name in the field labeled “Phone”. Otherwise, use a preexisting ...