Actions

Actions define the behavior that runs at each step of an IVR call flow, from playing announcements to transferring the caller.

Actions are the steps that carry out a task within an IVR flow — playing an announcement, collecting caller input, or transferring the call. See Actions and Conditions for how terminating and non-terminating actions affect the rest of the flow.


Drop Call

A terminating action that immediately disconnects the call.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Play AnnouncementOptional announcement played before the call is dropped.
📌

Use Case

Typically used after playing a final message, handling invalid input, or ending an IVR flow intentionally — for example, after a caller exhausts the maximum number of invalid menu attempts.


Forced Announcement

Plays an audio message that the caller cannot skip.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Play AnnouncementThe announcement played to the caller.
📌

Use Case

Commonly used for compliance messages, legal disclosures, emergency notices, or mandatory information before proceeding — for example, a call recording disclosure or a service outage notice.


Transfer

A terminating action that transfers the call to a specified destination such as another IVR call flow, a skill, an agent, or a dialable number.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Destination TypeThe transfer target: Transfer to IVR, Transfer to Skill, Transfer to Agent, or Transfer to Dialable Number.
📌

Use Case

This action is most often the final step before agent interaction, but it is also used as a sub-action attached to a condition — for example, transferring to a dedicated support IVR once a Parameter condition identifies the dialed number. See Call Routing Methods for a worked example.


Collect Digits

Prompts the caller to enter digits using their keypad (DTMF). The digit entry is finalized by the # key.

FieldDescription
Query NameName of the action displayed in reporting and call flows.
Session Parameter IDName of the key for the collected value; available as a parameter for other conditions and actions.
Play AnnouncementAnnouncement played when the call flow reaches this action.
Max Digits AllowedThe maximum number of digits accepted; defaults to Unlimited.
Digit Entry Confirmation LanguageThe language used for the announcements played during digit entry.
Timeout DurationThe maximum time given for the caller to input digits. If this time elapses, the digits entered up to that point are used.
Display Digits in Historical LoggingWhen enabled, the digits entered are displayed in reporting details alongside the session parameter ID.
Display to AgentWhen enabled, the digits entered are visible to the agent for the call alongside the session parameter ID.
Censor all but last four digitsWhen enabled, only the last four digits entered are displayed in reporting details and to the agent.
📌

Use Case

Used for collecting a string of digits such as menu selections, account numbers, PINs, or routing decisions based on caller input. The collected value is stored under the Session Parameter ID and can be read back later in the flow by a Parameter condition — see Parameters for how this value flows through the rest of the call.

Examples could include:

  • Account Number
  • Extension
  • Date of Birth
  • Callback Number

Collect Confirmation

Prompts the caller to enter digits using their keypad (DTMF) to confirm or deny a statement.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Session Parameter IDName of the key for the collected value; available as a parameter for other conditions and actions.
Consent AnnouncementThe announcement presented to the caller requesting confirmation.
Display Digits in Historical LoggingWhen enabled, the confirmation digit entered is displayed in reporting details alongside the session parameter ID.
Display to AgentWhen enabled, the confirmation digit entered is visible to the agent for the call alongside the session parameter ID.
📌

Use Case

Used for collecting binary responses from the caller such as consent to send SMS messages, gathering permissions, and/or acknowledgement of compliance disclosures.

Examples could include:

  • "Do you agree?"
  • "Do you want to continue?"
  • "Do you approve this action?"
  • "May we text you?"

Confirm Caller Number

Prompts the caller to confirm their phone number using their keypad (DTMF).

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Session Parameter IDName of the key for the collected value; available as a parameter for other conditions and actions.
Max Digits AllowedThe maximum number of digits accepted; defaults to Unlimited.
Timeout DurationThe maximum time given for the caller to input digits. If this time elapses, the digits entered up to that point are used.
Display Digits in Historical LoggingWhen enabled, the confirmation digit entered is displayed in reporting details alongside the session parameter ID.
Display to AgentWhen enabled, the confirmation digit entered is visible to the agent for the call alongside the session parameter ID.

Announcement Settings:

FieldDescription
Number Verification IntroThe first announcement played to the caller, reading back the digits entered for verification.
Number Confirmation PromptThe second announcement, asking the caller to confirm the digits are correct — 1 to confirm, 2 to reject.
Request Number PromptPlayed if the caller rejects the Number Confirmation Prompt, prompting them to re-enter the digits.
Confirmation Success AnnouncementPlayed once the caller confirms the digits are correct.
Digit Playback Language PackThe language used for the announcements played during confirmation.
Invalid Entry AnnouncementPlayed if the caller enters an invalid entry.
📌

Use Case

Used for confirming a callback number or a phone number to text and/or receive calls, with a built-in read-back and re-entry loop so the value stored is verified before the flow continues.


Set Parameter

An action that changes the behavior of the call flow and/or displays data to agents or in reporting.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Session Parameter IDName of the key for the value; available as a parameter for other conditions and actions.

Select one value source:

FieldDescription
Set as Static ValueAssigns a fixed string of text as the value whenever this action is triggered.
Set with Standard ParameterAssigns the value from a dropdown of existing standard parameters.
Set with Session ParameterAssigns the value from an existing Session Parameter ID.
📌

Use Case

Used to carry state forward through the rest of the call flow, independent of caller input. Examples include:

  • Marking that a call recording disclosure has already been announced, so it is not repeated later in the flow
  • Flagging that the caller is a specific type of member
  • Recording that the caller passed identity verification, so downstream skills or groups do not repeat the check

Data Dip

An action used to request data from a database in a call flow.

FieldDescription
Query NameName of the action displayed in reporting and call flows.
Data Dip ProfileThe Data Dip Profile executed as this action.
📌

Use Case

Used for changing the call behavior based on data requested from a database about the calling party, displaying data from a database to agents during a live call, and/or displaying data from a database in reporting. The returned value is stored as a parameter, the same way a Collect Digits or Set Parameter action stores one, so it can be read back later by a Parameter condition.


Digit Menu

A terminating action that transfers the caller out of the IVR and into a Digit Menu.

FieldDescription
Digit Menu ProfileThe Digit Menu Profile the caller is transferred into.
📌

Use Case

Used for completing an IVR by handing the caller off into a "phone-tree" of further menu options.


Send SMS

An action that sends an SMS message to the caller or a verified number and can receive a reply.

🛑

Consent Required for SMS Messages

A documented consent must be obtained from the caller for SMS messaging. Consent should include clear information about SMS purposes, the applicable privacy policy, and instructions for HELP and STOP (opt-out). SMS-enabled numbers must be registered with The Campaign Registry and comply with the applicable 10DLC requirements.

FieldDescription
Action NameName of the action displayed in reporting and call flows.
Outbound SMS DIDDropdown to select the outbound SMS number used to send the message.
Consent ParameterThe Session Parameter ID used to check for SMS consent.
Target Number SourceCaller ID Number uses the caller's caller ID number as the SMS destination. Verified Number uses a Session Parameter ID obtained from caller input by another action, set via Target Number Session Parameter.

SMS Settings:

FieldDescription
SMS MessageThe text sent to the target SMS number.
Successfully Sent AnnouncementPlayed when the SMS was consented to and sent successfully.
Not Sent AnnouncementPlayed when the SMS was not consented to and therefore not sent.
Failed to Send AnnouncementPlayed when the SMS message failed to send.
📌

Use Case

The consent check reads the Session Parameter set earlier in the flow — typically by a Collect Confirmation action asking the caller to opt in — so consent must be collected and stored before this action runs.