Method
Description
amd string[] $options ) : AmdResult
Runs the AMD() application. For a complete list of options see:
https://wiki.asterisk.org/wiki/display/AST/Application_AMD
answer void
Answers the current channel. Uses agi command "ANSWER".
channelStatus string $channel = '' ) : integer
Retrieves channel status. Uses agi command "CHANNEL STATUS"
consoleLog string $msg ) : void
Logs to asterisk console. Uses agi command "VERBOSE".
createNode string $name ) : Node
Convenient method to create a node.
createNodeController string $name ) : NodeController
Creates a new node controller.
databaseDel string $family , string $key ) : void
Deletes an entry in the Asterisk database for a given family and key.
databaseDeltree string $family , string $key = false ) : void
Deletes a family or specific keytree withing a family in the Asterisk database.
databaseGet string $family , string $key ) : string
Retrieves an entry in the Asterisk database for a given family and key.
databasePut string $family , string $key , string $value ) : void
Adds or updates an entry in the Asterisk database for a given family, key, and value.
dial string $channel , array $options = [] ) : DialResult
Tries to dial the given channel.
exec string $application , array $options = [] ) : ExecResult
Executes an application. Uses agi command "EXEC".
faxReceive string $tiffFile ) : FaxResult
Receives a fax.
faxSend string $tiffFile ) : FaxResult
Sends a fax.
getAsteriskLogger PAGI\Logger\Asterisk\IAsteriskLogger
Returns an asterisk logger facade.
getCDR PAGI\CDR\ICDR
Returns a cdr facade.
getCallerId ICallerID
Returns a caller id facade.
getChannelVariables PAGI\ChannelVariables\IChannelVariables
Returns an instance of ChannelVariables to access agi variables.
getData string $file , integer $maxTime , string $maxDigits ) : PlayResult
Reads input from user. Uses agi command "GET DATA".
getFullVariable string $name , string $channel = false ) : string
Returns a variable value. Uses agi command "GET FULL VARIABLE". False if
variable is not set.
getOption string $file , string $escapeDigits , integer $maxTime ) : PlayResult
Reads input from user. Uses agi command "GET OPTION".
getVariable string $name ) : string
Returns a variable value. Uses agi command "GET VARIABLE". False if
variable is not set.
hangup void
Hangups the current channel. Uses agi command "HANGUP".
indicateBusy integer $timeout ) : ExecResult
Indicates busy and waits for hangup. Does not play a busy tone.
indicateCongestion integer $timeout ) : ExecResult
Indicates congestion and waits for hangup. Does not play a busy tone.
indicateProgress ExecResult
Indicates progress of a call, starting early audio.
log string $msg , string $priority = 'NOTICE' ) : void
Logs to asterisk logger. Uses application LOG.
playBusyTone ExecResult
Plays "Busy" tone, defined in indications.conf
playCongestionTone ExecResult
Plays "Congestion" tone, defined in indications.conf
playCustomTones array $frequencies ) : ExecResult
Plays a customized frequency tone.
playDialTone ExecResult
Plays "Dial" tone, defined in indications.conf
playTone string $tone ) : ExecResult
Plays a tone defined in indications.conf.
record string $file , string $format , string $escapeDigits , integer $maxRecordTime , integer $silence = false ) : PAGI\Client\Result\RecordResult
Record to a file until are received as dtmf.
sayAlpha string $what , string $escapeDigits = '' ) : PlayResult
Say a given character string, returning early if any of the given DTMF
digits are received on the channel. Uses agi command "SAY PHONETIC".
sayDate integer $time , string $escapeDigits = '' ) : PlayResult
Say a given date, returning early if any of the given DTMF
digits are received on the channel. Uses agi command "SAY DATE".
sayDateTime integer $time , string $format , string $escapeDigits = '' ) : PlayResult
Say a given date and time, returning early if any of the given DTMF
digits are received on the channel. Uses agi command "SAY DATETIME".
sayDigits string $digits , string $escapeDigits = '' ) : PlayResult
Says digits. Uses agi command "SAY DIGITS".
sayNumber string $digits , string $escapeDigits = '' ) : PlayResult
Says a number. Uses agi command "SAY NUMBER".
sayPhonetic string $what , string $escapeDigits = '' ) : PlayResult
Say a given character string with phonetics, returning early if any of
the given DTMF digits are received on the channel.
sayTime integer $time , string $escapeDigits = '' ) : PlayResult
Says time. Uses agi command "SAY TIME".
sendImage string $filename ) : void
Sends the given image on a channel. Uses agi command "SEND IMAGE".
sendText string $text ) : void
Sends the given text on a channel. Uses agi command "SEND TEXT".
setAutoHangup integer $time ) : void
Cause the channel to automatically hangup at seconds in the future.
setCallerId string $name , string $number ) : void
Changes the callerid of the current channel. Uses agi command
"SET CALLERID"
setContext string $context ) : void
Changes the context for continuation upon exiting the application.
setExtension string $extension ) : void
Changes the extension for continuation upon exiting the application.
setLogger Psr\Log\LoggerInterface $logger ) : void
Sets the logger implementation.
setMusic boolean $enable , string $class = false ) : void
Enables/Disables the music on hold generator. Uses agi command "SET MUSIC".
setPriority string $priority ) : void
Changes the priority for continuation upon exiting the application.
setVariable string $name , string $value ) : void
Sets a variable. Uses agi command "SET VARIABLE".
sipHeaderAdd string $name , string $value ) : ExecResult
Adds a SIP header to the first invite message in a dial command.
sipHeaderRemove string $name ) : ExecResult
Removes a header previously added with sipHeaderAdd.
stopPlayingTones ExecResult
Stop playing current played tones.
streamFile string $file , string $escapeDigits = '' ) : PlayResult
Plays a file, can be interrupted by escapeDigits.
waitDigit integer $timeout ) : DigitReadResult
Waits up to milliseconds for channel to receive a DTMF digit.
