AGI_AsteriskManager</head> <body> <h1>AGI_AsteriskManager</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"> The AGI_AsteriskManager class provides an API to the Asterisk Manager. AGI_AsteriskManager is not part of the current release version 1.12, it is only available from CVS. <P> AGI_AsteriskManager should be considered <i>experimental</i>. Most notably the asm_XXXXXXXX application functions are not fully tested, or even implemented. <P> <b>Note: This documentation is rough, just in time for the holidays.</B> <P> <P> An example script, <a href="as-test.phps">as-test.phps</a> runs as an AGI within Asterisk, connects to the local manager and 1) pings once a second, and 2) dumps events from the manager. <P> <h1>CREATING A NEW INSTANCE OF THE CLASS</h1> <HR> <P> The class can be created standalone of phpagi.php, or through phpagi. <h2<STANDALONE:</h2> <pre> require "phpagi-asmanager.php"; $as = new AGI_AsteriskManager(); </pre> <h2>FROM PHPAGI:</h2> <pre> require "phpagi.php"; $agi = new AGI(); $as = $agi->new_asm(); </pre> <P> Notes:<P> <ul> <li>If the class is created using $agi->new_asm(), AGI_AsteriskManager will use phpagi for logging to the Asterisk console. </li> <li>phpagi.php will include phpagi-asmanager.php by itself. <li>if phpagi-asmanager.php is included _before_ phpagi.php, phpagi.php will not attempt to re-include it.</li> <li>if phpagi.php tries to include phpagi-asmanager.php but is unable to do so, an< error will be echoed to the asterisk console and the script will continue running normally. in this case the return value of new_asm() will be FALSE.</li> </ul> <h1>CONFIGURATION</h1> phpagi-asmanager uses the same configuration file as phpagi.conf (usually /etc/asterisk/phpagi.conf). All configuration information specific to phpagi-asmanager is contained in the [asmanager] section of the .conf file. <P> (note: not implemented) <P> supported directives: <P> <pre> [asmanager] # default manager port port=1234 </pre> <h1>CONNECTING</h1> <pre> $res=$as->connect("localhost","username","password"); if($res==FALSE) { echo "Connection failed.\n"; } if($res==TRUE){ echo "Connection established.\n"; } </pre> <P> A port can also be specified for the hostname. eg: <P> <pre> $res->$as->connect("my.asterisk.server:1234","username","port"); </pre> <P> if the port is not specified, the default manager port will be used instead. <P> <h1>SENDING REQUESTS</h1> <P> <pre> $as->send_request($eventname,$arrayofparameterstopass); </pre> <P> send_request() calls wait_request and returns an array of returned data from the manager. if something went wrong, it returns false. <P> wait_request() shouldn't need to be called from a script directly. <P> wait_request() will also detect events and dispatch any registered event handlers for the event. <P> examples: <P> <pre> $res=$as->send_request("EventName", array( "Channel"=>"Zap/1/16045551212", "AnotherParameter"=>"data" ) ); if($as->resp_is_success($res)){ echo "it worked!"; } if($as->resp_is_error($res)){ echo "it failed!\n"; } echo "Dump of returned data:\n"; foreach($res as $var=>$val){ echo "$var = $val\n"; } </pre> <h1>EVENTS</h1> <P> <ul> <li>TODO: non-blocking socket i/o. </li> <li>The class uses event callbacks to process events received from the manager.</li> </ul> <P> event callback prototype looks like: <P> <PRE> function dump_event($ecode,$data,$server,$port) { echo "received event '$ecode' from $server:$port\n"; print_r($data); } </PRE> <P> to register an event call back: <PRE> $as->add_event_handler($eventname,"eventfunction"); </PRE> <P> eg: <PRE> $as->add_event_handler("registry","dump_event"); </PRE> <P> the special eventname "*" can also be registered. any eventname not specifically registered will be handled by the "*" handler. if no * handler is defined, the event will be silently ignored. <P> <h1>PRECANNED FUNCTIONS</h1> <P> Undocumented.. <P> </td></tR> </table> </body></html>