Actions

All Callr Actions actions, their parameters, results and examples.

Every action has a name and a version, like dial@v2. This list shows the current version of each action: older versions keep working in existing scenarios, and each action page lists them.

An action runs in the branches listed on its page: the call actions need a live call (inbound-call and your own branches), the data and messaging actions also run without a call (api-initiated, inbound-sms, hangup).

Call control

ActionWhat it does
dial@v2Connect the current caller to another party. Replaces dial@v1 (cli becomes callerId, ring becomes an audioFile)
bridge@v3Bridge the outbound leg of a dial@v2 (or dial@v1); a beep (feedback) is played to both legs before bridging unless disabled
conference@v1Put the caller in a conference room. Callers of your account that use the same room are connected together; the room is created when the first caller enters it. The action blocks until the caller leaves the room (by pressing *, automatically as the last participant, or after a failed PIN), then the next action runs.
answer@v1Answer the call (inbound calls only)
ringing@v1Indicate ringing tone before the call is answered (inbound calls only)
hangup@v1Hangup the call, with optional Q.850 cause code
wait@v1Wait for a given amount of time
waitForSilence@v1Wait for silence
dtmf@v1Sends DTMF to the current call
amd@v3Answering Machine Detection

Audio

ActionWhat it does
play@v3Play a text-to-speech prompt (tts) or an audio file of your library (audioFile). Replaces say@v2 and play@v2.
playRecordingFile@v1Play a file recorded with record@v1

Caller input

ActionWhat it does
gather@v4Gather digits (DTMF) from the caller, optionally prompted by a text-to-speech (tts) or an audio file of your library (audioFile)
recognize@v3Recognize voice - Speech-to-Text

Recording

ActionWhat it does
startRecording@v2Start call recording. Replaces startRecording@v1 (the result is the lowercase recording SID)
stopRecording@v2Stop call recording. Replaces stopRecording@v1 (the result is the lowercase recording SID)
record@v1Record raw audio
saveRecordingFile@v1Save a file recorded with record@v1 as a Recording object in the API

Messaging

ActionWhat it does
sms@v1Send SMS
email@v1Send an email

Data & integrations

ActionWhat it does
fetch@v3Fetch HTTP resource
javascript@v1Execute JavaScript code
memcache@v1Key/value store for short term storage
log@v1Log something
googleAnalytics@v1Measure offline (phone) interactions with Google Analytics
mixpanel@v1Push event to Mixpanel

AI

ActionWhat it does
openai@v3Communicate with OpenAI's API
voicebot@v1AI agent

The full definition of every action is in the JSON Schema. The Callr Console editor validates your YAML against it and shows this documentation inline.


Did this page help you?