AGI Commands: Cheat Sheet

47 entries, compact print-friendly format

AGI Commands | AsteriskRecipes.com Cheat Sheet
Name Syntax Synopsis Since
ANSWER answer Answer channel 0.4.0
ASYNCAGI BREAK asyncagi break Interrupts Async AGI 1.8.0
CHANNEL STATUS channel status channelname Returns status of the connected channel. 0.4.0
CONTROL STREAM FILE control stream file filename escape_digits skipms ffchar rewchr pausechr offsetms Sends audio file on channel and allows the listener to control the stream. 1.2.0
DATABASE DEL database del family key Removes database key/value 0.4.0
DATABASE DELTREE database deltree family keytree Removes database keytree/value 0.4.0
DATABASE GET database get family key Gets database value 0.4.0
DATABASE PUT database put family key value Adds/updates database value 0.4.0
EXEC exec application options Executes a given Application 0.4.0
GET DATA get data file timeout maxdigits Prompts for DTMF on a channel 0.4.0
GET FULL VARIABLE get full variable expression channelname Evaluates a channel expression 1.2.0
GET OPTION get option filename escape_digits timeout Stream file, prompt for DTMF, with timeout. 1.2.0
GET VARIABLE get variable variablename Gets a channel variable. 0.4.0
GOSUB gosub context extension priority optional-argument Cause the channel to execute the specified dialplan subroutine. N/A
HANGUP hangup channelname Hangup a channel. 0.4.0
NOOP noop Does nothing. 0.4.0
RECEIVE CHAR receive char timeout Receives one character from channels supporting it. 0.4.0
RECEIVE TEXT receive text timeout Receives text from channels supporting it. 1.2.0
RECORD FILE record file filename format escape_digits timeout offset_samples beep s=silence Records to a given file. 0.4.0
SAY ALPHA say alpha number escape_digits Says a given character string. 1.2.0
SAY DATE say date date escape_digits Says a given date. 1.2.0
SAY DATETIME say datetime time escape_digits format timezone Says a given time as specified by the format given. 1.2.0
SAY DIGITS say digits number escape_digits Says a given digit string. 0.4.0
SAY NUMBER say number number escape_digits gender Says a given number. 0.4.0
SAY PHONETIC say phonetic string escape_digits Says a given character string with phonetics. 1.0.0
SAY TIME say time time escape_digits Says a given time. 1.0.0
SEND IMAGE send image image Sends images to channels supporting it. 0.4.0
SEND TEXT send text text to send Sends text to channels supporting it. 0.4.0
SET AUTOHANGUP set autohangup time Autohangup channel in some time. 0.4.0
SET CALLERID set callerid number Sets callerid for the current channel. 0.4.0
SET CONTEXT set context desired context Sets channel context. 0.4.0
SET EXTENSION set extension new extension Changes channel extension. 0.4.0
SET MUSIC set music boolean class Enable/Disable Music on hold generator 0.5.0
SET PRIORITY set priority priority Set channel dialplan priority. 0.4.0
SET VARIABLE set variable variablename value Sets a channel variable. 0.4.0
SPEECH ACTIVATE GRAMMAR speech activate grammar grammar name Activates a grammar. 1.6.0
SPEECH CREATE speech create engine Creates a speech object. 1.6.0
SPEECH DEACTIVATE GRAMMAR speech deactivate grammar grammar name Deactivates a grammar. 1.6.0
SPEECH DESTROY speech destroy Destroys a speech object. 1.6.0
SPEECH LOAD GRAMMAR speech load grammar grammar name path to grammar Loads a grammar. 1.6.0
SPEECH RECOGNIZE speech recognize prompt timeout offset Recognizes speech. 1.6.0
SPEECH SET speech set name value Sets a speech engine setting. 1.6.0
SPEECH UNLOAD GRAMMAR speech unload grammar grammar name Unloads a grammar. 1.6.0
STREAM FILE stream file filename escape_digits sample offset Sends audio file on channel. 0.4.0
TDD MODE tdd mode boolean Toggles TDD mode (for the deaf). 0.4.0
VERBOSE verbose message level Logs a message to the asterisk verbose log. 0.4.0
WAIT FOR DIGIT wait for digit timeout Waits for a digit to be pressed. 0.4.0