text
stringlengths
0
152
Chapter 18: Asterisk Gateway Interface
AGI command
RECORD FILE
SAY ALPHA
SAY DIGITS
SAY NUMBER
SAY PHONETIC
SAY DATE
SAY TIME
SAY DATETIME
SEND IMAGE
SEND TEXT
SET AUTOHANGUP
SET CALLERID
SET CONTEXT
SET EXTENSION
SET MUSIC
SET PRIORITY
SET VARIABLE
STREAM FILE
CONTROL STREAM FILE
TDD MODE
VERBOSE
WAIT FOR DIGIT
SPEECH CREATE
SPEECH SET
SPEECH DESTROY
SPEECH LOAD GRAMMAR
SPEECH UNLOAD GRAM
MAR
Description
Record the audio from the caller to a file. This is a blocking operation similar to the
Record() dialplan application. To record a call in the background while you perform other
operations, use EXEC Monitor or EXEC MixMonitor.
Say a string of characters. You can find an example of this in “Quick Start” on page 315. To get
localized handling of this and the other SAY commands, set the channel language either in
the device configuration file (e.g., sip.conf) or in the dialplan, by setting the CHANNEL(lan
guage) dialplan function.
Say a string of digits. For example, 100 would be said as “one zero zero” if the channel’s
language is set to English.
Say a number. For example, 100 would be said as “one hundred” if the channel’s language is
set to English.
Say a string of characters, but use a common word for each letter (Alpha, Bravo, Charlie…).
Say a given date.
Say a given time.
Say a given date and time using a specified format.
Send an image to a channel. IAX2 supports this, but there are no actively developed IAX2
clients that support it that we know of.
Send text to a channel that supports it. This can be used with SIP and IAX2 channels, at least.
Schedule the channel to be hung up at a specified point in time in the future.
Set the caller ID name and number on the channel.
Set the current dialplan context on the channel.
Set the current dialplan extension on the channel.
Start or stop music on hold on the channel.
Set the current dialplan priority on the channel.
Set a channel variable to a given value.
Stream the contents of a file to a channel.
Stream the contents of a file to a channel, but also allow the channel to control the stream.
For example, the channel can pause, rewind, or fast-forward the stream.
Toggle the TDD (Telecommunications Device for the Deaf) mode on the channel.
Send a message to the verbose logger channel. Verbose messages show up on the Asterisk
console if the verbose setting is high enough. Verbose messages will also go to any logfile
that has been configured for the verbose logger channel in /etc/asterisk/logger.conf.
Wait for the caller to press a digit.
Initialize speech recognition. This must be done before using other speech AGI commands.b
Set a speech engine setting. The settings that are available are specific to the speech
recognition engine in use.
Destroy resources that were allocated for doing speech recognition. This command should be
the last speech command executed.
Load a grammar.
Unload a grammar.