>gpmdZddlZddlZddlZddlZddlmZdZdZejdZ ejdZ Gdd e Z Gd d e ZGd d eZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddZed k(rPeZej7d!ej9ej:d ej=d"d!ejCd$d%ejEd$ ejEd& ejGd$d%d&ejGd$d(d)ejGd$d*d+ejId$d%Z%ej>jAd,e%zejId%d$Z%ej>jAd,e%zejMd$d%ejOd$ej9yy#e$rej>jAd#Y'wxYw#e$rej>jAd'YwxYw#e$rej>jAd-YwxYw).a .. module:: agi :synopsis: This module contains functions and classes to implment AGI scripts in python. 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 ------------- N)PY3ii Nz (^\d*)\s*(.*)z6(?P\w+)=(?P[^\s]+)\s*(?:\((?P.*)\))*c eZdZy) AGIExceptionN__name__ __module__ __qualname__?/opt/asterisk_venv/lib/python3.12/site-packages/asterisk/agi.pyrr'r rc eZdZy)AGIErrorNrr r r rr+r r rc eZdZy)AGIUnknownErrorNrr r r rr/r r rc eZdZy) AGIAppErrorNrr r r rr3r r rc eZdZy) AGIHangupNrr r r rr:r r rc eZdZy)AGISIGHUPHangupNrr r r rr>r r rc eZdZy)AGISIGPIPEHangupNrr r r rrBr r rc eZdZy)AGIResultHangupNrr r r rrFr r rc eZdZy) AGIDBErrorNrr r r rrJr r rc eZdZy) AGIUsageErrorNrr r r rrNr r rc eZdZy)AGIInvalidCommandNrr r r r!r!Rr r r!ceZdZdZej ej ejfdZdZ dZ dZ dZ dZ dZej fd Zd Zd Zefd Zd6d ZefdZd7dZd8dZd9dZdZd6dZd6dZd6dZd6dZd6dZd6dZd:dZ edfdZ!d8dZ"dZ#dZ$d Z%d:d!Z&d"d#e'dd$dfd%Z(d&Z)d6d'Z*d6d(Z+d)Z,d6d*Z-d+Z.d,Z/d;d.Z0d?--/ 2;$  tOG +g56 '" r cd}ddi}|jjj}tr"t |t ur|j d}|jjd|ztj|}|r|j\}}t|}|dk(r~tjD]3\}}} || f||<| dk(r td|dk(s$|d k(s*t!d |jjd t#j$|z|S|d k(r t'|d k(r|g} |jjj}tr"t |t ur|j d}|dddk7rj| j)||jjj}tr"t |t ur|j d}|dddk7rj| j)|ddj+| z} t-| t/|d)z*Read the result of a command from Asteriskrresult)r8r8r7z RESULT_LINE: %s hangupzUser hungup during execution-1z&Error executing application, or hangupz RESULT_DICT: %s iiN520z%s r%z$Unhandled code or undefined response)r&r:r;rr<r=r>r(r-re_codesearchgroupsrJre_kvfindallrrrArBr!appendr@rr) r3r&coderfrCmresponserDvaluerEusages r rXzAGI.get_resultsH%zz""$**, DzU"4;;v+>D 1D89 NN4  XXZND(t9D 3;$)MM($; P UD$dms 8#)*HII(?u}%&NOO P KK  5v8NN OM S[#H- - S[FE::&&(..0D:&t{{6/Br(e# T"zz**,224DzU*4;;v3FD r(e# LL TYYu--E& &!$(NO Or ct|turdjtt|}|j |S)Nr8)r<listr@rbr.rN)r3digitss r _process_digit_listzAGI._process_digit_lists2 <4 WWSf-.F{{6""r c2|jdddy)zUagi.answer() --> None Answer channel if not already in answer state. ANSWERrfrNr^rSs r answerz AGI.answers Xx(+r c|jd|dd}|dk(ry tt|S#t$rt d|zwxYw)zagi.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 zWAIT FOR DIGITrfr0r8%Unable to convert result to digit: %s)r^chrrJ ValueErrorrr3timeoutress r wait_for_digitzAGI.wait_for_digits_ ll+W5h?B #: N3s8}$ NFLMM Ns 4A cR|jd|j|ddy)zagi.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 z SEND TEXTrfrNr^rN)r3texts r send_textz AGI.send_texts% [$++d"34X>qAr c|jd|dd}|dk(ry tt|S#td|zxYw)aagi.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. z RECEIVE CHARrfrrr8$Unable to convert result to char: %s)r^rrJrrs r receive_charzAGI.receive_charsU ll>73H=a@ #: M3s8}$ MEKLLs 4AcT|jd|dd}|dk(r tdy)zagi.tdd_mode(mode='on'|'off') --> None Enable/Disable TDD transmission/reception on a channel. Throws AGIAppError if channel is not TDD-capable. zTDD MODErfrrzChannel %s is not TDD-capableN)r^r)r3moders r tdd_modez AGI.tdd_modes6 ll:t,X6q9 #:=> > r rc|j|}|jd|||}|dd}|dk(ry tt|S#t d|zxYw)aCagi.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. z STREAM FILErfrrr8rrzr^rrJr)r3filename escape_digits sample_offsetrtrs r stream_filezAGI.stream_filesr00? << 8]MCx # #: M3s8}$ MEKLLs A Ac T|j|}|jd|j|||j||j||j||j|}|dd}|dk(ry tt |S#t d|zxYw)a 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. zCONTROL STREAM FILErfrrr8rrzr^rNrrJr) r3rrskipmsfwdrewpausertrs r control_stream_filezAGI.control_stream_file&s00? << 5t{{87Lm]a]h]hio]prvr}r}BsCEIEPEPQTEUW[WbWbchWijx # #: M3s8}$ MEKLLs BB'c|jd|dd}|dk7r(td|jjddzy) zagi.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 z SEND IMAGErfrrzChannel falure on channel %s agi_channelUNKNOWNN)r^rr1get)r3rrs r send_imagezAGI.send_image;sT ll<28 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 z SAY DIGITSrfrrr8rr)r3ryrrs r say_digitszAGI.say_digitsFw ))&100? ll<?I!L #: M3s8}$ MEKLL AA'c|j|}|j|}|jd||dd}|dk(ry tt|S#t d|zxYw)zagi.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 z SAY NUMBERrfrrr8rr)r3numberrrs r say_numberzAGI.say_numberWrrc|j|}|j|}|jd||dd}|dk(ry tt|S#t d|zxYw)zagi.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 z SAY ALPHArfrrr8rrr3 charactersrrs r say_alphaz AGI.say_alphahsw --j9 00? ll; MB8LQO #: M3s8}$ MEKLLrc|j|}|j|}|jd||dd}|dk(ry tt|S#t d|zxYw)zagi.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 z SAY PHONETICrfrrr8rrrs r say_phoneticzAGI.say_phoneticys --j9 00? ll J 77?AABD #: M3s8}$ MEKLLrc|j|}|jd||dd}|dk(ry tt|S#t d|zxYw)zagi.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) zSAY DATErfrrr8rrr3secondsrrs r say_datez AGI.say_dateg 00? ll:w >xHK #: M3s8}$ MEKLL AAc|j|}|jd||dd}|dk(ry tt|S#t d|zxYw)zagi.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) zSAY TIMErfrrr8rrrs r say_timez AGI.say_timerrc|j|}|r|j|}|jd||||dd}|dk(ry tt |S#t d|zxYw)a1agi.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). z SAY DATETIMErfrrr8r)rzrNr^rrJr)r3rrformatzoners r say_datetimezAGI.say_datetimes 00? [[(Fll G]FDBBJLLMO #: M3s8}$ MEKLLs AA+c>|jd|||}|d\}}|S)zagi.get_data(filename, timeout=DEFAULT_TIMEOUT, max_digits=255) --> digits Stream the given file and receive dialed digits zGET DATArfr})r3rr max_digitsrfrrus r get_dataz AGI.get_datas+j(GZHH% U r c|j|}|r|jd|||}n|jd||}|dd}|dk(ry tt|S#t d|zxYw)aagi.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. z GET OPTIONrfrrr8rr)r3rrrrtrs r get_optionzAGI.get_options00? ||h w@H||L(MJHx # #: M3s8}$ MEKLLs AA/c(|jd|y)zagi.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. z SET CONTEXTNr})r3contexts r set_contextzAGI.set_contexts ]G,r c(|jd|y)aagi.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. z SET EXTENSIONNr})r3 extensions r set_extensionzAGI.set_extensions _i0r c(|jd|y)zagi.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. z set priorityNr})r3prioritys r set_priorityzAGI.set_prioritys ^X.r c|xs|jd}|xs|jd}|xs|jd}|j||j||j|y)N agi_context agi_extension agi_priority)r1rrr)r3rrrs r goto_on_exitzAGI.goto_on_exitse4TXXm4:/!: 7txx7 ! 9% (#r gsm#beepc |j|}|jd|j||||||d|zdd} tt |S#t d|zxYw)aagi.record_file(filename, format, escape_digits, timeout=DEFAULT_TIMEOUT, offset=0, beep='beep', silence=0) --> None Record to a file until a given dtmf digit in the sequence is received. Returns '-1' on hangup or error. The format will specify what kind of file will be recorded. The is the maximum record time in milliseconds, or '-1' for no . is optional, and, if provided, will seek to the offset without exceeding the end of the file. is the number of seconds of silence allowed before the function returns despite the lack of dtmf digits or reaching . value must be preceded by 's=' and is also optional. z RECORD FILEzs=%srfrrr) r3rrrroffsetrsilencers r record_filezAGI.record_files00? ll=$++h*?('64&7BRUU]__`b Js3x=  JBSHI Irc(|jd|y)aagi.set_autohangup(secs) --> None Cause the channel to automatically hangup at 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. zSET AUTOHANGUPNr})r3secss r set_autohangupzAGI.set_autohangups %t,r c(|jd|y)zagi.hangup(channel='') Hangs up the specified channel. If no channel name is given, hangs up the current channel HANGUPNr})r3channels r rhz AGI.hangups Xw'r c|jd||j|}|dd}|dk(rtd|z|S)zagi.appexec(application, options='') Executes with given . Returns whatever the application returns, or -2 on failure to find application EXECrfrz-2zUnable to find application: %s)r^rNr)r3 applicationoptionsrfrs r appexecz AGI.appexecsK fk4;;w3GHXq! $;>LM M r c(|jd|y)z_agi.set_callerid(number) --> None Changes the callerid of the current channel. z SET CALLERIDNr})r3rs r set_calleridzAGI.set_callerid+s ^V,r c |jd|}t|ddS#t$rt$rddi}Y)wxYw)aagi.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 zCHANNEL STATUSrf)rir8r)r^rrrJ)r3rrfs r channel_statuszAGI.channel_status1sU ,\\"2G>cf|jd|j||j|y)z Set a channel variable. z SET VARIABLENr)r3namerus r set_variablezAGI.set_variableIs& ^T[[%6 E8JKr c |jd|j|}|d\}}|S#t$rddi}YwxYw)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. z GET VARIABLErf1rhr^rNr)r3rrfrrus r get_variablezAGI.get_variableNsP  1\\.$++d2CDFH% U  10F 1s !- ==Nc |r2|jd|j||j|}n!|jd|j|}|d\}}|S#t$rddi}YwxYw)rzGET FULL VARIABLErfrr)r3rrrfrrus r get_full_variablezAGI.get_full_variable\s  1&9&*kk$&7W9MO&94;;t;LM H% U  10F 1sAA!! A10A1cH|jd|j||y)zagi.verbose(message='', level=1) --> None Sends to the console via verbose message system. is the the verbose level (1-4) VERBOSENr)r3messagelevels r verbosez AGI.verboseos Y G 4e str Retrieves an entry in the Asterisk database for a given family and key. Returns 0 if is not set. Returns 1 if is set and returns the variable in parenthesis example return code: 200 result=1 (testvariable) z"%s"z DATABASE GETrfrz"Key not found in database: family=, key=rzUnknown exception for : family=z , result=)r^rNrrrArBr3familyrDrfrrus r database_getzAGI.database_getvs&sl DKK/S1ACH% U #:$c+, , CZLU[]`bhbpbpqwbxyz zr c|jd|j||j||j|}|d\}}|dk(rtd|d|d|y)zagi.database_put(family, key, value) --> None Adds or updates an entry in the Asterisk database for a given family, key, and value. z DATABASE PUTrfrz(Unable to put vaule in databale: family=rz, value=Nr^rNr)r3rrDrurfrs r database_putzAGI.database_putsh ndkk /[[%t{{5'9;H% U #:_egjlqrs s r c|jd|j||j|}|d\}}|dk(rtd|d|y)zagi.database_del(family, key) --> None Deletes an entry in the Asterisk database for a given family and key. z DATABASE DELrfrz'Unable to delete from database: family=rNrrs r database_delzAGI.database_delsX  DKK/S1ACH% U #:TZ\_`a a r c|jd|j||j|}|d\}}|dk(rtd|d|y)zagi.database_deltree(family, key='') --> None Deletes a family or specific keytree with in a family in the Asterisk database. zDATABASE DELTREErfrz,Unable to delete tree from database: family=rNrrs r database_deltreezAGI.database_deltreesX   F 3T[[5EGH% U #:Y_adef f r c&|jdy)z1agi.noop() --> None Does nothing NOOPNr}rSs r noopzAGI.noops Vr cfdjtt|}|jd||S)zDSend an arbitrary asterisk command with args (even not AGI commands),r)r@rbr.r^rds r exec_commandzAGI.exec_commands+xxC'||FGT22r )r8)off)r8r)r8i r8r8r8)r8r8r8)N)r6)8rrr __doc__r/r&r'r(r4r2rNr,rTr^rWrXrzr~DEFAULT_TIMEOUTrrrrrrrrrrrrrrrrrrrrDEFAULT_RECORDrrrhrrrrrrrrrrrrrr r r r#r#VsF !YYszz#**  ( H C   #yy*PX# , &5 NB$3M ?M,M* FM"M"M"M$ M MM&*9SM2-1/$,1^delr|}J&-( - (0L &={( t b g 3r r#__main__z demo-congrats backgrounderz7Handled exception for missing application backgrounder foobarfoobarz.Handled exception for missing variable foobar bazfoobazbatfoobatzDBVALUE foo:bar = %s z5Handled exception for missing database entry bar:foo )(r r/rArer*sixrr r compilerlro Exceptionrrrrrrrrrrr!r#ragirrhexitrr(r-rrrrvrrr r r rs,  "**% & LM 9  |  h  (    i  y  i    H   _ 3_ 3D z %CLL!JJL CHHQK H NO4 UE"UL " F x0 x0 x0   UE * 1A56   UE * 1A56 & U# JJLc. H  F HH L JKL F  D FFs7H;I BH? I&%I&) J  J