CallMagic action

Overview

A CallMagic action connects your hotline to your CallMagic account. When a caller passes through it, something happens in CallMagic: they are saved to a group, taken off one, unsubscribed, given their latest message, or their active hours are set from the keypad.

You need a CallMagic account and its API token to use this. In the sidebar it lives under Advanced → CallMagic Actions. Everywhere a destination is picked, and on My Hotline, it is called CallMagic.

How It Works

The caller reaches the action.
If you asked for confirmation, they are told what is about to happen and press 1 to go ahead or 2 to cancel.
The action runs against CallMagic, using the caller's number.
Something is played: the message CallMagic returned, your own recording, or a spoken confirmation.
The call continues to the After Action route.

The "set active hours" action is different: it collects the times from the caller first, then saves them.

Settings

Basic Information

Name (required) — For your reference, e.g. "Save caller to newsletter group".
Phone System Reference → Extension ID — Only shown when your account has phone-system references turned on.

CallMagic Connection

API Token (required) — Your CallMagic API token, found in your CallMagic account settings. It is a password box with a reveal button. The token is what we use to read your groups, so fill it in first; the Group list below stays empty until it is set.

Action

Action Type (required) — One of:
- Save caller to group
- Remove caller from group
- Add caller to unsubscribers
- Play last message sent from this number
- Play last message sent from this number to caller
- Set active hours
Group (required for the save and remove actions) — Pulled live from CallMagic using your token. Searchable.
Require confirmation before running — Shown for the save, remove and unsubscribe actions. The caller is asked to press 1 to confirm or 2 to cancel before anything happens. Any other key is treated as an invalid entry and the question is asked again.
Time Entry Format (set active hours only) — 24-hour (enter 0900, 1400, etc.), the default, or 12-hour with AM/PM prompt, which asks the caller to press 1 for AM or 2 for PM after each time.
Default End Time (optional) (set active hours only) — Four digits in 24-hour format, e.g. 2100. Set it and callers only enter a start time; the end time is filled in for them. Leave it blank to ask for both.

Prompt recordings

Every spoken prompt can be replaced with your own recording. Leave one blank and the caller hears the default text spoken. Time announcements such as "Start time set to 9 AM" always use speech.

Confirmation Prompts

A collapsed section, shown for the save, remove and unsubscribe actions once Require confirmation is on. The default wording shown under each field changes with the action you picked.

Prompt	Default wording (save to group)
Confirmation prompt	`"To save you to the group, press 1. To cancel, press 2."`
Cancelled prompt	`"Cancelled. You have not been saved to the group."`
Completed prompt	`"You have been saved to the group."` — only used when no Prompt After Action audio is set
Invalid entry prompt	`"That entry was not valid. Please try again."`

Custom Prompts

A collapsed section, shown only for Set active hours.

Prompt	Default wording
Start time prompt	`"Please enter your active hours start time as 4 digits..."`
End time prompt	`"Now enter your end time as 4 digits."`
AM/PM prompt	`"For A M, press 1. For P M, press 2."`
Invalid entry prompt	`"That entry was not valid. Please try again."`

Prompt After Action

Audio Prompt — Played after the action runs, before the caller is routed onward. When you set this, it replaces the spoken "completed" message.

For the two "play last message" actions, whatever CallMagic returns is played instead.

Routing

Route	When it fires
After the action (on the form: After Action)	The action has run, or the caller cancelled it

A cancelled action still continues to this route, so point it back at your menu rather than leaving callers in silence.

A scheduled task with the action Change where a menu key / route goes can retarget this route on a timetable.

Tips

Fill in the API token before anything else. The Group picker is fetched from CallMagic live, so it is empty until the token is saved.
Ask for confirmation on anything destructive. Removing someone from a group or unsubscribing them because they pressed a key by mistake is annoying to undo.
Set a Default End Time if your callers always work to the same closing hour. One four-digit entry is far easier on the phone than two.
Record your own prompts for the confirmation and completion messages. Spoken defaults are fine for testing, but your own voice sounds like your hotline.