Constructor AGI_1 (line 60)

Constructor

• string $config: is the name of the config file to parse
• array $optconfig: is an array of configuration vars and vals, stuffed into $this->config['phpagi']

agi_dtmf2text (line 293)

Read $len characters as DTMF codes

• integer $len

agi_getdtmf (line 248)

Plays the given file and receives DTMF data.

This is similar to STREAM FILE, but this command can accept and return many DTMF digits, while STREAM FILE returns immediately after the first DTMF digit is detected.

Asterisk looks for the file to play in /var/lib/asterisk/sounds by default.

If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.

The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is restarted. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.

Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.

• return: of characters
• link: http://www.voip-info.org/wiki-get+data

• integer $len: number of digits to read
• integer $timeout: milliseconds
• string $terminator: character on which to quit
• string $prompt: file to play. Do not include file extension.

agi_hangup (line 432)

Hangup the current channel.

• link: http://www.voip-info.org/wiki-hangup

• string $channel

agi_play (line 474)

Play the given audio file, allowing playback to be interrupted by a #. This command is similar to the GET DATA command but this command returns after the first DTMF digit has been pressed while GET DATA can accumulated any number of digits before returning.

• link: http://www.voip-info.org/wiki-stream+file

• string $file: filename without extension, often in /var/lib/asterisk/sounds

agi_recordfile (line 460)

Record sound to a file until an acceptable DTMF digit is received or a specified amount of time has passed. Optionally the file BEEP is played before recording begins.

• link: http://www.voip-info.org/wiki-record+file

• string $file: to record, without extension, often created in /var/lib/asterisk/sounds
• string $format: of the file. GSM and WAV are commonly used formats. MP3 is read-only and thus cannot be used.
• integer $timeout: is the maximum record time in milliseconds, or -1 for no timeout.
• string $prompt: to play

agi_response_data (line 175)

Get the response data from the last command

agi_response_result (line 164)

Get the result code from the last command

agi_saydigits (line 497)

Say the given digit string, returning early if # is received on the channel.

• link: http://www.voip-info.org/wiki-say+digits

• integer $digits

agi_saytime (line 519)

Say a given time, returning early if # is received on the channel.

• link: http://www.voip-info.org/wiki-say+time

• integer $time: number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).

agi_verbose (line 144)

Sends $message to the Asterisk console via the 'verbose' message system.

If the Asterisk verbosity level is $vbl or greater, send $str to the console.

The Asterisk verbosity system works as follows. The Asterisk user gets to set the desired verbosity at startup time or later using the console 'set verbose' command. Messages are displayed on the console if their verbose level is less than or equal to desired verbosity set by the user. More important messages should have a low verbose level; less important messages should have a high verbose level.

• link: http://www.voip-info.org/wiki-verbose

• string $str
• integer $vbl: from 1 to 4

con_print_r (line 210)

Log to console if debug mode

• array $arr: to print
• string $label
• integer $vbl: verbose level
• $lvl

db_get (line 355)

Retrieves an entry in the Asterisk database for a given family and key.

• link: http://www.voip-info.org/wiki-database+get

• string $family
• string $key

enum_lookup (line 542)

Perform enum lookup

• string $telnumber
• string $rDNS

evalutate (line 74)

Evaluate an AGI command

• return: ('code'=>$code, 'result'=>$result, 'data'=>$data)
• access: private

• string $command

send_image (line 649)

Send the specified image on a channel.

Most channels do not support the transmission of images.

• return: true on success
• link: http://www.voip-info.org/wiki-send+image

• string $image: without extension, often in /var/lib/asterisk/images

AGI::send_image()

Send the specified image on a channel.

set_var (line 420)

Sets a variable to the specified value. The variables so created can later be used by later using ${<variablename>} in the dialplan.

These variables live in the channel Asterisk creates when you pickup a phone and as such they are both local and temporary. Variables created in one channel can not be accessed by another channel. When you hang up the phone, the channel is deleted and any variables in that channel are deleted as well.

• return: result code
• link: http://www.voip-info.org/wiki-set+variable

• string $var: is case sensitive
• string $val

AGI::set_var()

Sets a variable, using Asterisk 1.6 syntax.