AGI

pyvr

{‘agi_callerid’ : ‘mars.putland.int’,

‘agi_channel’ : ‘IAX[kputland@kputland]/119’, ‘agi_context’ : ‘default’, ‘agi_dnid’ : ‘1000’, ‘agi_enhanced’ : ‘0.0’, ‘agi_extension’: ‘1000’, ‘agi_language’ : ‘en’, ‘agi_priority’ : ‘1’, ‘agi_rdnis’ : ‘’, ‘agi_request’ : ‘pyst’, ‘agi_type’ : ‘IAX’}

Specification

class asterisk.agi.AGI(stdin=<open file '<stdin>', mode 'r'>, stdout=<open file '<stdout>', mode 'w'>, stderr=<open file '<stderr>', mode 'w'>)

This class encapsulates communication between Asterisk an a python script. It handles encoding commands to Asterisk and parsing responses from Asterisk.

answer()

agi.answer() –> None Answer channel if not already in answer state.

appexec(application, options='')

Executes <application> with given <options>. Returns whatever the application returns, or -2 on failure to find application

channel_status(channel='')

agi.channel_status(channel=’‘) –> int Returns the status of the specified channel. If no channel name is given the returns the status of the current channel.

Return values: 0 Channel is down and available 1 Channel is down, but reserved 2 Channel is off hook 3 Digits (or equivalent) have been dialed 4 Line is ringing 5 Remote end is ringing 6 Line is up 7 Line is busy

control_stream_file(filename, escape_digits='', skipms=3000, fwd='', rew='', pause='')

Send the given file, allowing playback to be interrupted by the given digits, if any. escape_digits is a string ‘12345’ or a list of ints [1,2,3,4,5] or strings [‘1’,‘2’,‘3’] or mixed [1,‘2’,3,‘4’] If sample offset is provided then the audio will seek to sample offset before play starts. Returns digit if one was pressed. Throws AGIError if the channel was disconnected. Remember, the file extension must not be included in the filename.

database_del(family, key)

agi.database_del(family, key) –> None Deletes an entry in the Asterisk database for a given family and key.

database_deltree(family, key='')

agi.database_deltree(family, key=’‘) –> None Deletes a family or specific keytree with in a family in the Asterisk database.

database_get(family, key)

agi.database_get(family, key) –> str Retrieves an entry in the Asterisk database for a given family and key. Returns 0 if <key> is not set. Returns 1 if <key> is set and returns the variable in parenthesis example return code: 200 result=1 (testvariable)

database_put(family, key, value)

agi.database_put(family, key, value) –> None Adds or updates an entry in the Asterisk database for a given family, key, and value.

get_data(filename, timeout=2000, max_digits=255)

agi.get_data(filename, timeout=DEFAULT_TIMEOUT, max_digits=255) –> digits Stream the given file and receive dialed digits

get_full_variable(name, channel=None)

Get a channel variable.

This function returns the value of the indicated channel variable. If the variable is not set, an empty string is returned.

get_option(filename, escape_digits='', timeout=0)

agi.get_option(filename, escape_digits=’‘, timeout=0) –> digit Send the given file, allowing playback to be interrupted by the given digits, if any. escape_digits is a string ‘12345’ or a list of ints [1,2,3,4,5] or strings [‘1’,‘2’,‘3’] or mixed [1,‘2’,3,‘4’] Returns digit if one was pressed. Throws AGIError if the channel was disconnected. Remember, the file extension must not be included in the filename.

get_result(stdin=<open file '<stdin>', mode 'r'>)

Read the result of a command from Asterisk

get_variable(name)

Get a channel variable.

This function returns the value of the indicated channel variable. If the variable is not set, an empty string is returned.

hangup(channel='')

Hangs up the specified channel. If no channel name is given, hangs up the current channel

noop()

agi.noop() –> None Does nothing

receive_char(timeout=2000)

agi.receive_char(timeout=DEFAULT_TIMEOUT) –> chr Receives a character of text on a channel. Specify timeout to be the maximum time to wait for input in milliseconds, or 0 for infinite. Most channels do not support the reception of text.

record_file(filename, format='gsm', escape_digits='#', timeout=20000, offset=0, beep='beep')

agi.record_file(filename, format, escape_digits, timeout=DEFAULT_TIMEOUT, offset=0, beep=’beep’) –> None Record to a file until a given dtmf digit in the sequence is received The format will specify what kind of file will be recorded. The timeout is the maximum record time in milliseconds, or -1 for no timeout. Offset samples is optional, and if provided will seek to the offset without exceeding the end of the file

say_alpha(characters, escape_digits='')

agi.say_alpha(string, escape_digits=’‘) –> digit Say a given character string, returning early if any of the given DTMF digits are received on the channel. Throws AGIError on channel failure

say_date(seconds, escape_digits='')

agi.say_date(seconds, escape_digits=’‘) –> digit Say a given date, returning early if any of the given DTMF digits are pressed. The date should be in seconds since the UNIX Epoch (Jan 1, 1970 00:00:00)

say_datetime(seconds, escape_digits='', format='', zone='')

agi.say_datetime(seconds, escape_digits=’‘, format=’‘, zone=’‘) –> digit Say a given date in the format specfied (see voicemail.conf), returning early if any of the given DTMF digits are pressed. The date should be in seconds since the UNIX Epoch (Jan 1, 1970 00:00:00).

say_digits(digits, escape_digits='')

agi.say_digits(digits, escape_digits=’‘) –> digit Say a given digit string, returning early if any of the given DTMF digits are received on the channel. Throws AGIError on channel failure

say_number(number, escape_digits='')

agi.say_number(number, escape_digits=’‘) –> digit Say a given digit string, returning early if any of the given DTMF digits are received on the channel. Throws AGIError on channel failure

say_phonetic(characters, escape_digits='')

agi.say_phonetic(string, escape_digits=’‘) –> digit Phonetically say a given character string, returning early if any of the given DTMF digits are received on the channel. Throws AGIError on channel failure

say_time(seconds, escape_digits='')

agi.say_time(seconds, escape_digits=’‘) –> digit Say a given time, returning early if any of the given DTMF digits are pressed. The time should be in seconds since the UNIX Epoch (Jan 1, 1970 00:00:00)

send_command(command, *args)

Send a command to Asterisk

send_image(filename)

agi.send_image(filename) –> None Sends the given image on a channel. Most channels do not support the transmission of images. Image names should not include extensions. Throws AGIError on channel failure

send_text(text='')

agi.send_text(text=’‘) –> None Sends the given text on a channel. Most channels do not support the transmission of text. Throws AGIError on error/hangup

set_autohangup(secs)

agi.set_autohangup(secs) –> None Cause the channel to automatically hangup at <secs> seconds in the future. Of course it can be hungup before then as well. Setting to 0 will cause the autohangup feature to be disabled on this channel.

set_callerid(number)

agi.set_callerid(number) –> None Changes the callerid of the current channel.

set_context(context)

Sets the context for continuation upon exiting the application. No error appears to be produced. Does not set exten or priority Use at your own risk. Ensure that you specify a valid context.

set_extension(extension)

Sets the extension for continuation upon exiting the application. No error appears to be produced. Does not set context or priority Use at your own risk. Ensure that you specify a valid extension.

set_priority(priority)

Sets the priority for continuation upon exiting the application. No error appears to be produced. Does not set exten or context Use at your own risk. Ensure that you specify a valid priority.

set_variable(name, value)

Set a channel variable.

stream_file(filename, escape_digits='', sample_offset=0)

agi.stream_file(filename, escape_digits=’‘, sample_offset=0) –> digit Send the given file, allowing playback to be interrupted by the given digits, if any. escape_digits is a string ‘12345’ or a list of ints [1,2,3,4,5] or strings [‘1’,‘2’,‘3’] or mixed [1,‘2’,3,‘4’] If sample offset is provided then the audio will seek to sample offset before play starts. Returns digit if one was pressed. Throws AGIError if the channel was disconnected. Remember, the file extension must not be included in the filename.

tdd_mode(mode='off')

agi.tdd_mode(mode=’on’|’off’) –> None Enable/Disable TDD transmission/reception on a channel. Throws AGIAppError if channel is not TDD-capable.

test_hangup()

This function throws AGIHangup if we have recieved a SIGHUP

verbose(message, level=1)

agi.verbose(message=’‘, level=1) –> None Sends <message> to the console via verbose message system. <level> is the the verbose level (1-4)

wait_for_digit(timeout=2000)

agi.wait_for_digit(timeout=DEFAULT_TIMEOUT) –> digit Waits for up to ‘timeout’ milliseconds for a channel to receive a DTMF digit. Returns digit dialed Throws AGIError on channel falure