[phpAGI] element index

All elements

a

top

$asmanager: AGI::$asmanager in phpagi.php

Asterisk Manager
$audio: AGI::$audio in phpagi.php

Audio Stream
AbsoluteTimeout: AGI_AsteriskManager::AbsoluteTimeout() in phpagi-asmanager.php

Set Absolute Timeout
add_event_handler: AGI_AsteriskManager::add_event_handler() in phpagi-asmanager.php

Add event handler
AGI: AGI in phpagi.php

AGI class
AGI: AGI::AGI() in phpagi.php

Constructor
AGIRES_OK: AGIRES_OK in phpagi.php
AGI_1: AGI_1 in phpagi_1.php

Asterisk Manager class
AGI_1: AGI_1::AGI_1() in phpagi_1.php

Constructor
AGI_AsteriskManager: AGI_AsteriskManager::AGI_AsteriskManager() in phpagi-asmanager.php

Constructor
AGI_AsteriskManager: AGI_AsteriskManager in phpagi-asmanager.php

Asterisk Manager class
agi_channel_status: AGI_1::agi_channel_status() in phpagi_1.php

Get the status of the specified channel.
agi_dtmf2text: AGI_1::agi_dtmf2text() in phpagi_1.php

Read $len characters as DTMF codes
agi_exec: AGI_1::agi_exec() in phpagi_1.php

Execute an AGI command
agi_getdtmf: AGI_1::agi_getdtmf() in phpagi_1.php

Plays the given file and receives DTMF data.
agi_goto: AGI_1::agi_goto() in phpagi_1.php

Goto - Set context, extension and priority
agi_hangup: AGI_1::agi_hangup() in phpagi_1.php

Hangup the current channel.
agi_is_error: AGI_1::agi_is_error() in phpagi_1.php

Check for error in result structure
agi_play: AGI_1::agi_play() in phpagi_1.php

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.
agi_readresult: AGI_1::agi_readresult() in phpagi_1.php

Read the result from Asterisk
agi_recordfile: AGI_1::agi_recordfile() in phpagi_1.php

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.
agi_response_code: AGI_1::agi_response_code() in phpagi_1.php

Get the response code from the last command
agi_response_data: AGI_1::agi_response_data() in phpagi_1.php

Get the response data from the last command
agi_response_is_error: AGI_1::agi_response_is_error() in phpagi_1.php

Check for error in response
agi_response_result: AGI_1::agi_response_result() in phpagi_1.php

Get the result code from the last command
agi_response_var: AGI_1::agi_response_var() in phpagi_1.php

Get the response variable from the last command
agi_saydigits: AGI_1::agi_saydigits() in phpagi_1.php

Say the given digit string, returning early if # is received on the channel.
agi_saynumber: AGI_1::agi_saynumber() in phpagi_1.php

Say the given number, returning early if # is received on the channel.
agi_saytime: AGI_1::agi_saytime() in phpagi_1.php

Say a given time, returning early if # is received on the channel.
agi_setlanguage: AGI_1::agi_setlanguage() in phpagi_1.php

Set Language
agi_verbose: AGI_1::agi_verbose() in phpagi_1.php

Sends $message to the Asterisk console via the 'verbose' message system.
answer: AGI::answer() in phpagi.php

Answer channel if not already in answer state.
arr2str: AGI_1::arr2str() in phpagi_1.php

Alias of PHP join function
AST_CONFIG_DIR: AST_CONFIG_DIR in phpagi.php
AST_DIGIT_ANY: AST_DIGIT_ANY in phpagi.php
AST_SPOOL_DIR: AST_SPOOL_DIR in phpagi.php
AST_STATE_BUSY: AST_STATE_BUSY in phpagi.php
AST_STATE_DIALING: AST_STATE_DIALING in phpagi.php
AST_STATE_DIALING_OFFHOOK: AST_STATE_DIALING_OFFHOOK in phpagi.php
AST_STATE_DOWN: AST_STATE_DOWN in phpagi.php
AST_STATE_OFFHOOK: AST_STATE_OFFHOOK in phpagi.php
AST_STATE_PRERING: AST_STATE_PRERING in phpagi.php
AST_STATE_RESERVED: AST_STATE_RESERVED in phpagi.php
AST_STATE_RING: AST_STATE_RING in phpagi.php
AST_STATE_RINGING: AST_STATE_RINGING in phpagi.php
AST_STATE_UP: AST_STATE_UP in phpagi.php
AST_TMP_DIR: AST_TMP_DIR in phpagi.php
AUDIO_FILENO: AUDIO_FILENO in phpagi.php

c

top

$config: AGI::$config in phpagi.php

Config variables
$config: AGI_AsteriskManager::$config in phpagi-asmanager.php

Config variables
ChangeMonitor: AGI_AsteriskManager::ChangeMonitor() in phpagi-asmanager.php

Change monitoring filename of a channel
channel_status: AGI::channel_status() in phpagi.php

Get the status of the specified channel. If no channel name is specified, return the status of the current channel.
Command: AGI_AsteriskManager::Command() in phpagi-asmanager.php

Execute Command
conlog: AGI::conlog() in phpagi.php

Log to console if debug mode.
connect: AGI_AsteriskManager::connect() in phpagi-asmanager.php

Connect to Asterisk
con_print_r: AGI_1::con_print_r() in phpagi_1.php

Log to console if debug mode

d

top

database_del: AGI::database_del() in phpagi.php

Deletes an entry in the Asterisk database for a given family and key.
database_deltree: AGI::database_deltree() in phpagi.php

Deletes a family or specific keytree within a family in the Asterisk database.
database_get: AGI::database_get() in phpagi.php

Retrieves an entry in the Asterisk database for a given family and key.
database_put: AGI::database_put() in phpagi.php

Adds or updates an entry in the Asterisk database for a given family, key, and value.
db_del: AGI_1::db_del() in phpagi_1.php

Deletes an entry in the Asterisk database for a given family and key.
db_get: AGI_1::db_get() in phpagi_1.php

Retrieves an entry in the Asterisk database for a given family and key.
db_put: AGI_1::db_put() in phpagi_1.php

Adds or updates an entry in the Asterisk database for a given family, key, and value.
DEFAULT_PHPAGI_CONFIG: DEFAULT_PHPAGI_CONFIG in phpagi.php
disconnect: AGI_AsteriskManager::disconnect() in phpagi-asmanager.php

Disconnect

e

top

$event_handlers: AGI_AsteriskManager::$event_handlers in phpagi-asmanager.php

Event Handlers
enum_lookup: AGI_1::enum_lookup() in phpagi_1.php

Perform enum lookup
enum_txtlookup: AGI_1::enum_txtlookup() in phpagi_1.php

Perform enum txt lookup
evaluate: AGI::evaluate() in phpagi.php

Evaluate an AGI command.
evalutate: AGI_1::evalutate() in phpagi_1.php

Evaluate an AGI command
Events: AGI_AsteriskManager::Events() in phpagi-asmanager.php

Enable/Disable sending of events to this manager
exec: AGI::exec() in phpagi.php

Executes the specified Asterisk application with given options.
exec_absolutetimeout: AGI::exec_absolutetimeout() in phpagi.php

Set absolute maximum time of call.
exec_agi: AGI::exec_agi() in phpagi.php

Executes an AGI compliant application.
exec_dial: AGI::exec_dial() in phpagi.php

Dial.
exec_enumlookup: AGI::exec_enumlookup() in phpagi.php

Do ENUM Lookup.
exec_goto: AGI::exec_goto() in phpagi.php

Goto.
exec_setlanguage: AGI::exec_setlanguage() in phpagi.php

Set Language.
ExtensionState: AGI_AsteriskManager::ExtensionState() in phpagi-asmanager.php

Check Extension Status

f

top

fastpass_get_data: AGI::fastpass_get_data() in phpagi.php

Plays the given file and receives DTMF data.
fastpass_say_digits: AGI::fastpass_say_digits() in phpagi.php

Say the given digit string, returning early if any of the given DTMF escape digits are received on the channel.
fastpass_say_number: AGI::fastpass_say_number() in phpagi.php

Say the given number, returning early if any of the given DTMF escape digits are received on the channel.
fastpass_say_phonetic: AGI::fastpass_say_phonetic() in phpagi.php

Say the given character string, returning early if any of the given DTMF escape digits are received on the channel.
fastpass_say_punctuation: AGI::fastpass_say_punctuation() in phpagi.php

Say Puncutation in a string.
fastpass_say_time: AGI::fastpass_say_time() in phpagi.php

Say a given time, returning early if any of the given DTMF escape digits are received on the channel.
fastpass_stream_file: AGI::fastpass_stream_file() in phpagi.php

Play the given audio file, allowing playback to be interrupted by a DTMF digit. 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.
fastpass_swift: AGI::fastpass_swift() in phpagi.php

Use Cepstral Swift to read text.
fastpass_text2wav: AGI::fastpass_text2wav() in phpagi.php

Use festival to read text.

g

top

GetVar: AGI_AsteriskManager::GetVar() in phpagi-asmanager.php

Gets a Channel Variable
get_data: AGI::get_data() in phpagi.php

Plays the given file and receives DTMF data.
get_var: AGI_1::get_var() in phpagi_1.php

Fetch the value of a variable.
get_variable: AGI::get_variable() in phpagi.php

Fetch the value of a variable.
goto: AGI::goto() in phpagi.php

Goto - Set context, extension and priority.

h

top

hangup: AGI::hangup() in phpagi.php

Hangup the specified channel. If no channel name is given, hang up the current channel.
Hangup: AGI_AsteriskManager::Hangup() in phpagi-asmanager.php

Hangup Channel

i

top

$in: AGI::$in in phpagi.php

Input Stream
IAXPeers: AGI_AsteriskManager::IAXPeers() in phpagi-asmanager.php

List IAX Peers

l

top

ListCommands: AGI_AsteriskManager::ListCommands() in phpagi-asmanager.php

List available manager commands
log: AGI_AsteriskManager::log() in phpagi-asmanager.php
Logoff: AGI_AsteriskManager::Logoff() in phpagi-asmanager.php

Logoff Manager

m

top

MailboxCount: AGI_AsteriskManager::MailboxCount() in phpagi-asmanager.php

Check Mailbox Message Count
MailboxStatus: AGI_AsteriskManager::MailboxStatus() in phpagi-asmanager.php

Check Mailbox
make_folder: AGI::make_folder() in phpagi.php

Make a folder recursively.
menu: AGI::menu() in phpagi.php

Menu.
Monitor: AGI_AsteriskManager::Monitor() in phpagi-asmanager.php

Monitor a channel

n

top

new_AsteriskManager: AGI::new_AsteriskManager() in phpagi.php

Create a new AGI_AsteriskManager.
noop: AGI::noop() in phpagi.php

Does nothing.

o

top

$out: AGI::$out in phpagi.php

Output Stream
Originate: AGI_AsteriskManager::Originate() in phpagi-asmanager.php

Originate Call

p

top

$pagi: AGI_AsteriskManager::$pagi in phpagi-asmanager.php

Parent AGI
$port: AGI_AsteriskManager::$port in phpagi-asmanager.php

Port on the server we are connected to
ParkedCalls: AGI_AsteriskManager::ParkedCalls() in phpagi-asmanager.php

List parked calls
parse_callerid: AGI::parse_callerid() in phpagi.php

Parse caller id.
phpagi-asmanager.php: phpagi-asmanager.php in phpagi-asmanager.php
phpagi-fastagi.php: phpagi-fastagi.php in phpagi-fastagi.php
phpagi_1.php: phpagi_1.php in phpagi_1.php
phpagi_error_handler: phpagi_error_handler() in phpagi.php

error handler for phpagi.
phpagi.php: phpagi.php in phpagi.php
Ping: AGI_AsteriskManager::Ping() in phpagi-asmanager.php

Ping
process_event: AGI_AsteriskManager::process_event() in phpagi-asmanager.php

Process event

q

top

QueueAdd: AGI_AsteriskManager::QueueAdd() in phpagi-asmanager.php

Queue Add
QueueRemove: AGI_AsteriskManager::QueueRemove() in phpagi-asmanager.php

Queue Remove
Queues: AGI_AsteriskManager::Queues() in phpagi-asmanager.php

Queues
QueueStatus: AGI_AsteriskManager::QueueStatus() in phpagi-asmanager.php

Queue Status

r

top

$request: AGI::$request in phpagi.php

Request variables read in on initialization.
$response: AGI_1::$response in phpagi_1.php

Response structure
receive_char: AGI::receive_char() in phpagi.php

Receive a character of text from a connected channel. Waits up to $timeout milliseconds for a character to arrive, or infinitely if $timeout is zero.
record_file: AGI::record_file() in phpagi.php

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.
Redirect: AGI_AsteriskManager::Redirect() in phpagi-asmanager.php

Redirect

s

top

$server: AGI_AsteriskManager::$server in phpagi-asmanager.php

Server we are connected to
$socket: AGI_AsteriskManager::$socket in phpagi-asmanager.php

Socket
say_digits: AGI::say_digits() in phpagi.php

Say the given digit string, returning early if any of the given DTMF escape digits are received on the channel.
say_number: AGI::say_number() in phpagi.php

Say the given number, returning early if any of the given DTMF escape digits are received on the channel.
say_phonetic: AGI::say_phonetic() in phpagi.php

Say the given character string, returning early if any of the given DTMF escape digits are received on the channel.
say_punctuation: AGI::say_punctuation() in phpagi.php

Say Puncutation in a string.
say_time: AGI::say_time() in phpagi.php

Say a given time, returning early if any of the given DTMF escape digits are received on the channel.
send_image: AGI_1::send_image() in phpagi_1.php

Send the specified image on a channel.
send_image: AGI::send_image() in phpagi.php

Send the specified image on a channel.
send_request: AGI_AsteriskManager::send_request() in phpagi-asmanager.php

Send a request
send_text: AGI::send_text() in phpagi.php

Send the given text to the connected channel.
send_text: AGI_1::send_text() in phpagi_1.php

Send the given text to the connected channel.
SetCDRUserField: AGI_AsteriskManager::SetCDRUserField() in phpagi-asmanager.php

Set the CDR UserField
SetVar: AGI_AsteriskManager::SetVar() in phpagi-asmanager.php

Set Channel Variable
set_autohangup: AGI::set_autohangup() in phpagi.php

Cause the channel to automatically hangup at $time seconds in the future.
set_callerid: AGI::set_callerid() in phpagi.php

Changes the caller ID of the current channel.
set_context: AGI::set_context() in phpagi.php

Sets the context for continuation upon exiting the application.
set_extension: AGI::set_extension() in phpagi.php

Set the extension to be used for continuation upon exiting the application.
set_music: AGI::set_music() in phpagi.php

Enable/Disable Music on hold generator.
set_priority: AGI::set_priority() in phpagi.php

Set the priority to be used for continuation upon exiting the application.
set_var: AGI_1::set_var() in phpagi_1.php

Sets a variable to the specified value. The variables so created can later be used by later using ${<variablename>} in the dialplan.
set_variable: AGI::set_variable() in phpagi.php

Sets a variable to the specified value. The variables so created can later be used by later using ${<variablename>} in the dialplan.
Status: AGI_AsteriskManager::Status() in phpagi-asmanager.php

Channel Status
StopMontor: AGI_AsteriskManager::StopMontor() in phpagi-asmanager.php

Stop monitoring a channel
stream_file: AGI::stream_file() in phpagi.php

Play the given audio file, allowing playback to be interrupted by a DTMF digit. 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.
swift: AGI::swift() in phpagi.php

Use Cepstral Swift to read text.

t

top

tdd_mode: AGI::tdd_mode() in phpagi.php

Enable or disable TDD transmission/reception on the current channel.
text2wav: AGI::text2wav() in phpagi.php

Use festival to read text.
text_input: AGI::text_input() in phpagi.php

Text Input.

v

top

verbose: AGI::verbose() in phpagi.php

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

w

top

wait_for_digit: AGI::wait_for_digit() in phpagi.php

Waits up to $timeout milliseconds for channel to receive a DTMF digit.
wait_response: AGI_AsteriskManager::wait_response() in phpagi-asmanager.php

Wait for a response
which: AGI::which() in phpagi.php

Find an execuable in the path.

z

top

ZapDialOffhook: AGI_AsteriskManager::ZapDialOffhook() in phpagi-asmanager.php

Dial over Zap channel while offhook
ZapDNDoff: AGI_AsteriskManager::ZapDNDoff() in phpagi-asmanager.php

Toggle Zap channel Do Not Disturb status OFF
ZapDNDon: AGI_AsteriskManager::ZapDNDon() in phpagi-asmanager.php

Toggle Zap channel Do Not Disturb status ON
ZapHangup: AGI_AsteriskManager::ZapHangup() in phpagi-asmanager.php

Hangup Zap Channel
ZapShowChannels: AGI_AsteriskManager::ZapShowChannels() in phpagi-asmanager.php

Zap Show Channels
ZapTransfer: AGI_AsteriskManager::ZapTransfer() in phpagi-asmanager.php

Transfer Zap Channel