AGI()</head> <body> <h1>AGI()</h1> <P> <table cellpadding=5 cellspacing=5> <tr><td valign=top> <a href="/">PHPAGI</a> <P> <B>phpagi-2.x</b><P> <a href="phpagi-2/docs/">Class Documentation</a> <P> <B>phpagi-1.x</b><P> <a href="phpagi-1/phpagi.docs.php">AGI</a><BR> <a href="phpagi-1/phpagi-as.docs.php">AGI_AsteriskManager</a><BR> <P> <B>Project Links</B><P> <a href="https://sourceforge.net/projects/phpagi">Source Forge Project</a><BR> <a href="https://sourceforge.net/cvs/?group_id=106629">CVS</a><BR> <a href="http://prdownloads.sourceforge.net/phpagi/?download">Download</a><BR> <a href="https://sourceforge.net/tracker/?group_id=106629&atid=645057">Bugs</a><BR> <a href="https://sourceforge.net/project/showfiles.php?group_id=106629">Feature Requests</a><BR> <a href="/examples/phpagi.conf">example config</a><BR> <P></td><td valign="top" style="border-left: 1px gray solid"> <html> <head> </head> <body> <a name="top"></a> <ul> <li><a href="#faq">FAQ / Errata</a> <li><a href="#functions">functions</a> <ul> <li><a href="#newagi">new AGI()</a></li><li><a href="#agiexec">agi_exec</a></li><li><a href="#readresult">agi_readresult</a></li><li><a href="#iserror">agi_is_error</a></li><li><a href="#variables">dialplan variables</a></li><li><a href="#errorpull">retrieving information on the last response</a></li><li><a href="#agidtmf">dtmf functions</a></li><li><a href="#agichan">channel functions</a></li><li><a href="#logging">logging functions</a></li><li><a href="#speech">speech, playback and recording functions</a></li><li><a href="#database">database functions</a></li><li><a href="#enum">enum functions</a></li><li><a href="#misc">miscellaneous crud</a></li></li></ul> <li><a href="#config">configuration</a></li> <li><a href="#request">the asterisk request</a></li> <li><a href="#examples">examples</a></li> <ul> <li><A href="#ping">ping a host</a></li> </ul> </ul> <P> <a name="faq"><h1>Frequently Asked Quizles and erratic errata</h1></a> <P> <h2>Why doesn't DIAL or AbsoluteTimeout work?</h2> <P> Some people are getting stumped on why some Asterisk commands do not appear to work from AGI. <P> Commands such as bsoluteTimeout or DIAL are <a href="http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands">Asterisk Applications</a> which have to be run using the AGI EXEC command. The AGI EXEC command should not be confused with agi_exec, which executes AGI commands, not Asterisk applications. This means that you need to execute the AGI command EXEC to execute an Asterisk application. <P> More information: <ul> <li><a href="http://asterisk.drunkcoder.com/agi.cgi">Native AGI commands</a></li> <li><a href="http://www.voip-info.org/wiki-Asterisk+-+documentation+of+application+commands">Asterisk applications (eg: DIAL)</a></li> </ul> <P> For example:<P> <code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $agi</span><span style="color: #007700">=new </span><span style="color: #0000BB">AGI</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">/* The code below works */<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXEC AbsoluteTimeout 20"</span><span style="color: #007700">); </span><span style="color: #FF8000">// set the absolute timeout to 20 seconds<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXEC DIAL SIP/261361@fwd.pulver.com"</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/* The code below DOES NOT work<br /> $agi->agi_exec("AbsoluteTimeout 20"); // set the absolute timeout to 20 seconds<br /> $agi->agi_exec("DIAL SIP/261361@fwd.pulver.com"); <br /><br /> */<br /> <br /></span><span style="color: #0000BB">?></span> </span> </code> <P> <h2>My AGI script isn't retrieving variables or is acting strangely</h2> <P> Make sure there is no leading or trailing white space in phpagi.php or your AGI script. This includes blank lines. <P> If you have any blank lines or spaces after the last ?> closing tag in phpagi.php, communications between your AGI script and Asterisk may fail. <P> <HR> <P> <a name="functions"><h1>Functions</h1></a> <P> <h2><a name="newagi">new AGI()</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /> $agi </span><span style="color: #007700">= new </span><span style="color: #0000BB">AGI</span><span style="color: #007700">(</span><span style="color: #0000BB">$cfgfile</span><span style="color: #007700">=</span><span style="color: #DD0000">"/etc/asterisk/phpagi.conf"</span><span style="color: #007700">,</span><span style="color: #0000BB">$confarray</span><span style="color: #007700">=</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">); <br /><br /> </span><span style="color: #FF8000">/*<br /> * creates a new AGI class. As part of the construction, phpagi also:<br /> * + Reads in the Asterisk request and stores the data in $agi->request<br /> * + Reads the configuration /etc/asterisk/phpagi.conf and stores the array in $agi->config<br /> *<br /> *<br /> * to specify an alternative configuration file, pass the file name to AGI()<br /> * the second parameter is an array of variables that are stored in $config['phpagi'].<br /> *<br /> */ <br /><br /> <br /></span><span style="color: #0000BB">?><br /></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="agiexec">agi_exec</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">/* Executes an Asterisk AGI command. */<br /><br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"SET PRIORITY 5"</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXEC DIAL sip/foo@foo.com"</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">/*<br /> * agi_exec returns an array containing:<br /> *<br /> * ['code'] = A 3 digit return code.<br /> * ['data'] = String data<br /> * [variable names] = individual variable=value pairs.<br /> */<br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="readresult">agi_readresult</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> <br /> $res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_readresult</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">=</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/*<br /> * reads a response from asterisk (or parses the string '$str'; which <br /> * is intended for debugging purposes only).<br /> *<br /> * note: has multiline response support, but is bodgy. someone should fix it.<br /> *<br /> *<br /> * returns an array consisting of:<br /> */<br /> </span><span style="color: #007700">array(<br /> </span><span style="color: #DD0000">"code" </span><span style="color: #FF8000">// numeric response code from asterisk (usually 200 if it worked),<br /> </span><span style="color: #DD0000">"result" </span><span style="color: #FF8000">// a numeric result code from asterisk (function specific)<br /> </span><span style="color: #DD0000">"data" </span><span style="color: #FF8000">// a string result returned from asterisk (ie: DATABASE GET)<br /> </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$var</span><span style="color: #DD0000">" </span><span style="color: #FF8000">// any variable=value responses from asterisk (ie: STREAM FILE's endpos=1234)<br /> </span><span style="color: #007700">)<br /><br /><br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="iserror">agi_is_error</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_is_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$resparr</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns TRUE or FALSE if the response $resparr (as returned from agi_readresult)<br /> * included a response code of 500, or a result code of -1<br /> */<br /></span><span style="color: #0000BB">?><br /></span><br /></span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="variables">dialplan variables</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">set_var</span><span style="color: #007700">(</span><span style="color: #DD0000">"SOME_VAR"</span><span style="color: #007700">,</span><span style="color: #DD0000">"blah blah"</span><span style="color: #007700">); </span><span style="color: #FF8000">// set a variable in the dialplan<br /><br /> </span><span style="color: #0000BB">$codec </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">get_var</span><span style="color: #007700">(</span><span style="color: #DD0000">"SIP_CODEC"</span><span style="color: #007700">); </span><span style="color: #FF8000">// get the value of SIP_CODEC<br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="errorpull">retrieving information on the last response</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">/*<br /> * AGI scripts can make requests to Asterisk to modify the dial plan<br /> * or run an Application. Responses to requests can be obtained using these<br /> * functions.<br /> */<br /><br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_response_code</span><span style="color: #007700">();<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns the last response code received from asterisk<br /> */<br /> <br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_response_result</span><span style="color: #007700">();<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns the last response result recieved from asterisk<br /> */<br /> <br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">response_data</span><span style="color: #007700">();<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns the last response text data received from asterisk<br /> */<br /> <br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">agi</span><span style="color: #007700">-></span><span style="color: #0000BB">response_var</span><span style="color: #007700">(</span><span style="color: #0000BB">$var</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns the value of "$var" from the last asterisk response, or FALSE if<br /> * $var was not returned.<br /> */<br /> <br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="agidtmf">dtmf functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_getdtmf</span><span style="color: #007700">(</span><span style="color: #0000BB">$len</span><span style="color: #007700">,</span><span style="color: #0000BB">$timeout</span><span style="color: #007700">,</span><span style="color: #0000BB">$terminator</span><span style="color: #007700">,</span><span style="color: #0000BB">$prompt</span><span style="color: #007700">=</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/*<br /> * Plays back each file specified in $prompt (either a single file, or a group<br /> * of files as an array()<br /> *<br /> * Waits for $len DTMF tones to be entered, or until $terminator is pressed.<br /> *<br /> * Each DTMF digit must be entered after $timeout milliseconds.<br /> *<br /> * Returns an array() of digits entered.<br /> *<br /> * ie:<br /> */<br /> <br /> <br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="agichan">channel functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> <br /> </span><span style="color: #FF8000">/*<br /> * returns the channel status of $channel as an array containing:<br /> *<br /> *<br /> * array(<br /> * "status" => status code (refer to agi reference)<br /> * "description" => human readable description of status<br /> * )<br /> *<br /> */<br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_channel_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$channel</span><span style="color: #007700">);<br /><br /><br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">hangup</span><span style="color: #007700">(); </span><span style="color: #FF8000">// hangup the current channel.<br /><br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">set_callerid</span><span style="color: #007700">(</span><span style="color: #DD0000">"6045551212"</span><span style="color: #007700">); </span><span style="color: #FF8000">// set the outgoing caller ID for this channel<br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="logging">logging functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $agi</span><span style="color: #007700">-></span><span style="color: #0000BB">conlog</span><span style="color: #007700">(</span><span style="color: #DD0000">"This will display a message to the asterisk console if debugging is enabled."</span><span style="color: #007700">);<br /><br /><br /> </span><span style="color: #FF8000">/* con_print_r will dump a variable to the asterisk console if debugging is enabled. potentially cpu unfriendly.*/<br /> </span><span style="color: #0000BB">$arr</span><span style="color: #007700">=array(<br /> </span><span style="color: #DD0000">"some key"</span><span style="color: #007700">=></span><span style="color: #DD0000">"some value"<br /> </span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">con_print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$arr</span><span style="color: #007700">,</span><span style="color: #DD0000">"My array data"</span><span style="color: #007700">);<br /><br /><br /> </span><span style="color: #FF8000">// verbose will print a message to the console. Optional second parameter is the verbosity level.<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_verbose</span><span style="color: #007700">(</span><span style="color: #DD0000">"This will display a message to the Asterisk console regardless of debugging"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="speech">speech, playback and recording functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /> $agi</span><span style="color: #007700">-></span><span style="color: #0000BB">saynumber</span><span style="color: #007700">(</span><span style="color: #DD0000">"1234"</span><span style="color: #007700">); </span><span style="color: #FF8000">// speaks the number 1234<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">saydigits</span><span style="color: #007700">(</span><span style="color: #DD0000">"1234"</span><span style="color: #007700">); </span><span style="color: #FF8000">// speaks the digits 1, 2, 3 and 4.<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">saytime</span><span style="color: #007700">(); </span><span style="color: #FF8000">// speaks the current time. <br /><br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">text2wav</span><span style="color: #007700">(</span><span style="color: #DD0000">"These are some words eh?"</span><span style="color: #007700">); </span><span style="color: #FF8000">// speaks the phrase "These are some words eh?" using Festival.<br /><br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">play</span><span style="color: #007700">(</span><span style="color: #DD0000">"welcome"</span><span style="color: #007700">); </span><span style="color: #FF8000">// plays a file on the current channel.<br /><br /> /*<br /> Plays the prompt "say-something", then records up to 10000 milliseconds of audio to the file "somefile.gsm" <br /> */<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">recordfile</span><span style="color: #007700">(</span><span style="color: #DD0000">"somefile"</span><span style="color: #007700">,</span><span style="color: #DD0000">"gsm"</span><span style="color: #007700">,</span><span style="color: #0000BB">10000</span><span style="color: #007700">,</span><span style="color: #DD0000">"say-something"</span><span style="color: #007700">);<br /><br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="database">database functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">/*<br /> Asterisk uses a database to store various bits of information. <br /><br /> Data is organized like so:<br /><br /> /FAMILY_NAME/Key Name/Some Value.<br /><br /> example:<br /><br /> /UserBalance/CustomerName/10.00<br /> <br /> Key names can contain /'s:<br /><br /> /SIP/Registry/1006/192.168.5.1:5060:3600:1006<br /><br /> <br /><br /> */<br /><br /> // db_put($family,$key,$value) <br /> // stuff the caller id of the person calling me into the lastcalledme family.<br /><br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">db_put</span><span style="color: #007700">(</span><span style="color: #DD0000">"lastcalledme"</span><span style="color: #007700">,</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">request</span><span style="color: #007700">[</span><span style="color: #DD0000">'agi_extension'</span><span style="color: #007700">],</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">request</span><span style="color: #007700">[</span><span style="color: #DD0000">'callerid'</span><span style="color: #007700">]);<br /> <br /> </span><span style="color: #FF8000">// find out who last called me<br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">db_get</span><span style="color: #007700">(</span><span style="color: #DD0000">"lastcalledme"</span><span style="color: #007700">,</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">request</span><span style="color: #007700">[</span><span style="color: #DD0000">'agi_extension'</span><span style="color: #007700">]);<br /><br /><br /> </span><span style="color: #FF8000">// delete the key<br /> </span><span style="color: #0000BB">$ret</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">db_del</span><span style="color: #007700">(</span><span style="color: #DD0000">"lastcalledme"</span><span style="color: #007700">,</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">request</span><span style="color: #007700">[</span><span style="color: #DD0000">'agi_extension'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="enum">enum functions</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /> </span><span style="color: #FF8000">// Using Asterisk's built in EnumLookup application<br /><br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"EXEC EnumLookup 16049586111"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">conlog</span><span style="color: #007700">(</span><span style="color: #DD0000">"EnumLookup resolved the number to the VoIP URI: "</span><span style="color: #007700">.</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">get_var</span><span style="color: #007700">(</span><span style="color: #DD0000">"ENUM"</span><span style="color: #007700">));<br /><br /><br /> </span><span style="color: #FF8000">// phpagi ENUM functions (CVS - Aug 29 2004)<br /><br /> /*<br /> * enum_lookup - performs an enum lookup and returns a sorted array.<br /> *<br /> * Array<br /> * (<br /> * [0] => Array<br /> * (<br /> * [order] => 100<br /> * [prio] => 10<br /> * [tech] => E2U+SIP<br /> * [URI] => sip/9586111@mutual.bcwireless.net<br /> * <br /> * )<br /> * <br /> * )<br /> * <br /> * NOTES:<br /> * - Presently requires external "dig" utility. PHP5 support for dns_get_record TBD<br /> * - Number passed to enum_lookup may or may not start with a '+'<br /> */<br /> <br /> </span><span style="color: #0000BB">$enumres</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">enum_lookup</span><span style="color: #007700">(</span><span style="color: #DD0000">"16049586111"</span><span style="color: #007700">,</span><span style="color: #DD0000">"e164.org"</span><span style="color: #007700">);<br /><br /> if(</span><span style="color: #0000BB">$enumres</span><span style="color: #007700">==</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">){<br /> </span><span style="color: #FF8000">// the query failed.<br /><br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_play</span><span style="color: #007700">(</span><span style="color: #DD0000">"enum-lookup-failed"</span><span style="color: #007700">);<br /><br /> } else {<br /><br /> </span><span style="color: #FF8000">// something was returned, find an IAX or SIP record and dial it.<br /><br /> </span><span style="color: #007700">foreach(</span><span style="color: #0000BB">$enumres </span><span style="color: #007700">as </span><span style="color: #0000BB">$key</span><span style="color: #007700">=></span><span style="color: #0000BB">$row</span><span style="color: #007700">){<br /><br /> </span><span style="color: #0000BB">$tech </span><span style="color: #007700">= </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">tech</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$URI </span><span style="color: #007700">= </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">URI</span><span style="color: #007700">];<br /><br /> if(</span><span style="color: #0000BB">strstr</span><span style="color: #007700">(</span><span style="color: #0000BB">$tech</span><span style="color: #007700">, </span><span style="color: #DD0000">"IAX"</span><span style="color: #007700">) || </span><span style="color: #0000BB">strstr</span><span style="color: #007700">(</span><span style="color: #0000BB">$tech</span><span style="color: #007700">, </span><span style="color: #DD0000">"SIP"</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"DIAL \"</span><span style="color: #0000BB">$URI</span><span style="color: #DD0000">\""</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$flush </span><span style="color: #007700">= </span><span style="color: #0000BB">trim</span><span style="color: #007700">(</span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$in</span><span style="color: #007700">,</span><span style="color: #0000BB">4096</span><span style="color: #007700">));<br /><br /> if(</span><span style="color: #0000BB">$flush </span><span style="color: #007700">== </span><span style="color: #DD0000">"200 result=-1"</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">set_var</span><span style="color: #007700">(</span><span style="color: #DD0000">"PRIORITY"</span><span style="color: #007700">, (</span><span style="color: #0000BB">$agi</span><span style="color: #007700">[</span><span style="color: #0000BB">priority</span><span style="color: #007700">] + </span><span style="color: #0000BB">101</span><span style="color: #007700">) );<br /> }<br /> }<br /> }<br /><br /><br /> </span><span style="color: #FF8000">/*<br /> * enum_txtlookup - returns the value of a TXT record for a given phone number or FALSE if none found.<br /> *<br /> * NOTES:<br /> * - Presently requires external "dig" utility. PHP5 support for dns_get_record TBD<br /> * - Number passed to enum_lookup may or may not start with a '+'<br /> */<br /><br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">enum_txtlookup</span><span style="color: #007700">(</span><span style="color: #DD0000">"+16049586111"</span><span style="color: #007700">,</span><span style="color: #DD0000">"e164.org"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr><h2><a name="misc">miscellaneous crud</a></h2><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /> $res </span><span style="color: #007700">= </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">arr2str</span><span style="color: #007700">(</span><span style="color: #0000BB">$arr</span><span style="color: #007700">); </span><span style="color: #FF8000">// convert array $arr to a string<br /><br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">goto</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">,</span><span style="color: #0000BB">$ext</span><span style="color: #007700">=</span><span style="color: #DD0000">'s'</span><span style="color: #007700">,</span><span style="color: #0000BB">$pri</span><span style="color: #007700">=</span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">// moves in the dialplan to $context, default extension 's' and priority of 1.<br /><br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_setlanguage</span><span style="color: #007700">(</span><span style="color: #0000BB">$lang</span><span style="color: #007700">); </span><span style="color: #FF8000">// sets the current language to $lang. defaults to 'en'<br /><br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">parse_callerid</span><span style="color: #007700">(); </span><span style="color: #FF8000">// parse a caller id string into distinct name and number elements.<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">conlog</span><span style="color: #007700">(</span><span style="color: #DD0000">"Callerid name is "</span><span style="color: #007700">.</span><span style="color: #0000BB">$res</span><span style="color: #007700">[</span><span style="color: #DD0000">'name'</span><span style="color: #007700">].</span><span style="color: #DD0000">" and number is "</span><span style="color: #007700">.</span><span style="color: #0000BB">$res</span><span style="color: #007700">[</span><span style="color: #DD0000">'number'</span><span style="color: #007700">]);<br /> <br /></span><span style="color: #0000BB">?></span> </span> </code><div align="right">- <a href="#top">top</a></div><hr> <a name="config"><h1>Configuration</h1></a> At construction time, phpagi will parse the contents of the INI style /etc/asterisk/phpagi.conf and store the contents of the file as an array named $agi->config; <P> The format of the configuration file is: <pre> [section] variable=value [other section] foo=bar </pre> <P> and the config array will look something like: <P> <pre> array( "section"=>array( "variable"=>"value" ), "other section"=>array( "foo"=>"bar" ) ); </pre> <P> An example <a href="phpagi.example.conf">configuration file</a> is available. <P> <P> To have phpagi parse a different file, pass the name of the file to the AGI constructor. eg: <P> <P> <code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $agi </span><span style="color: #007700">= new </span><span style="color: #0000BB">AGI</span><span style="color: #007700">(</span><span style="color: #DD0000">"/some/other/file.conf"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code><P> Run-time variables can be specified as well. Pass an array of variables as the second argument to the constructor. These values are stored in the above configuration array within the element 'phpagi', therefor run-time configuration can override the phpagi section of phpagi.conf. <P> <code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /> $cfgarray</span><span style="color: #007700">=array(<br /> </span><span style="color: #DD0000">"error_handler"</span><span style="color: #007700">=></span><span style="color: #DD0000">"true"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"good_beer"</span><span style="color: #007700">=></span><span style="color: #DD0000">"winter solstace"<br /> </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$agi </span><span style="color: #007700">= new </span><span style="color: #0000BB">AGI</span><span style="color: #007700">(</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">,</span><span style="color: #0000BB">$cfgarray</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code><P> Here's a list of internal 'phpagi' variables. <P> <table width=100%> <tr><th>Name</th><th>values</th><th>Description</th></tr> <tr><td>error_handler</td><td>"true"/"false"</td><td>Enable the phpagi error handler - logs php parse errors to asterisk</td></tr. <tr><td>debug</td><td>"true"/"false"</td><td>Enable or disable debugging via conlog and conlog_print_r (defaults to "true")</td></tr> <tr><td>dig</td><td></td><td>Full path to the 'dig' dns lookup utility (eg: /usr/bin/dig</td></tr> </table> <P> <P> Other variables: <P> <table width="100%"> <tr><th>Section</th><th>Name</th><th>Values</th><th>Description</th></tr> <tr><td>festival</td><td>text2wav</td><td><i>/usr/src/festival/bin/text2wave</i></td><td>Path to the text2wav script</td></tr> <tr><td>festival</td><td>tempdir</td><td><i>/var/lib/asterisk/sounds/tmp/</td><td>Path to a temporary directory where text2wav can store files</td></tr> </table> <P> <hr> <a name="config"><h1>The Asterisk Request</h1></a> When Asterisk calls the AGI script, it will pass a number of request variables to the script. <P> The variables are automatically read at phpagi construction time and are stored in the variable $agi->request; <P> Example: <P> <pre> array( 'agi_request' => 'ping.php' 'agi_channel' => 'SIP/-080fc9d0' 'agi_language' => 'en' 'agi_type' => 'sip' 'agi_uniqueid' => '1069813784.9' 'agi_callerid' => 'Matthew 'agi_dnid' => 'unknown' 'agi_rdnis' => 'unknown' 'agi_context' => 'in-sip' 'agi_extension' => '*01' 'agi_priority' => '2' 'agi_enhanced' => '0.0' 'agi_accountcode' => '' ) </pre> Obviousley the request passed will vary from call to call, and channel used. The example above is from an incoming SIP call. <P> <hr> <a name="examples"><h1>Examples</h1></a> <a name="ping"><h2>Example - Ping AP</h2></a> <code><span style="color: #000000"> #!/usr/local/bin/php -q<br /><span style="color: #0000BB"><?php<br /><br /> </span><span style="color: #007700">require </span><span style="color: #DD0000">"phpagi.php"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$agi </span><span style="color: #007700">= new </span><span style="color: #0000BB">AGI</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"ANSWER"</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">// Play the "Enter the host you wish to ping, followed by the pound sign" prompt<br /> // and then play the beep.<br /> <br /> </span><span style="color: #0000BB">$host</span><span style="color: #007700">=</span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_getdtmf</span><span style="color: #007700">(</span><span style="color: #0000BB">20</span><span style="color: #007700">,</span><span style="color: #0000BB">3000</span><span style="color: #007700">,</span><span style="color: #DD0000">"#"</span><span style="color: #007700">,array(</span><span style="color: #DD0000">"ping"</span><span style="color: #007700">,</span><span style="color: #DD0000">"beep"</span><span style="color: #007700">));<br /><br /><br /> </span><span style="color: #FF8000">// $host is an array loaded up with each character entered.<br /> // here we go through the array and turn it into a string.<br /> // could have used $agi->arr2str as well but i didn't. <br /><br /> </span><span style="color: #007700">foreach(</span><span style="color: #0000BB">$host </span><span style="color: #007700">as </span><span style="color: #0000BB">$k</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$ip</span><span style="color: #007700">.=</span><span style="color: #0000BB">$k</span><span style="color: #007700">;<br /><br /><br /><br /> </span><span style="color: #FF8000">// change the '*' to .<br /><br /> </span><span style="color: #0000BB">$ip</span><span style="color: #007700">=</span><span style="color: #0000BB">str_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">"*"</span><span style="color: #007700">,</span><span style="color: #DD0000">"."</span><span style="color: #007700">,</span><span style="color: #0000BB">$ip</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">/* Danger Will Robinson! This does NOT properly escape the ping command!<br /> * Someone could subvert your system if you don't fix this! - NO WARRANTY :P */<br /> </span><span style="color: #0000BB">$execstr</span><span style="color: #007700">=</span><span style="color: #DD0000">"/bin/ping -c 5 -q -w 9 </span><span style="color: #0000BB">$ip</span><span style="color: #DD0000">|grep transmitted"</span><span style="color: #007700">;<br /> <br /> </span><span style="color: #FF8000">// be polite.<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">agi_exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"STREAM FILE thanks #"</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">=</span><span style="color: #0000BB">popen</span><span style="color: #007700">(</span><span style="color: #0000BB">$execstr</span><span style="color: #007700">,</span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /> if(</span><span style="color: #0000BB">$p</span><span style="color: #007700">==</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">){<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">conlog</span><span style="color: #007700">(</span><span style="color: #DD0000">"Failed to ping </span><span style="color: #0000BB">$execstr</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /> exit;<br /> }<br /> while(!</span><span style="color: #0000BB">feof</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">)){<br /> </span><span style="color: #0000BB">$r</span><span style="color: #007700">=</span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">,</span><span style="color: #0000BB">1024</span><span style="color: #007700">);<br /> if(!</span><span style="color: #0000BB">$r</span><span style="color: #007700">)<br /> break;<br /> </span><span style="color: #0000BB">$str</span><span style="color: #007700">.=</span><span style="color: #0000BB">$r</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #FF8000">// a minor hack.<br /> </span><span style="color: #0000BB">$str</span><span style="color: #007700">=</span><span style="color: #0000BB">str_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">"ms"</span><span style="color: #007700">,</span><span style="color: #DD0000">"milli-seconds"</span><span style="color: #007700">,</span><span style="color: #0000BB">$str</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #FF8000">// have festival read back the ping results.<br /> </span><span style="color: #0000BB">$agi</span><span style="color: #007700">-></span><span style="color: #0000BB">text2wav</span><span style="color: #007700">(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$ip</span><span style="color: #DD0000"> - </span><span style="color: #0000BB">$str</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></td></tR> </table> </body></html>