wormling / phparia
Asterisk REST Interface (ARI) client for PHP.
Installs: 9 773
Dependents: 1
Suggesters: 0
Security: 0
Stars: 39
Watchers: 13
Forks: 35
Open Issues: 17
Requires
- php: >=5.4
- clue/ami-react: ~0.3.0
- devristo/phpws: dev-master
- educoder/pest: 1.0.0
- evenement/evenement: >=2.0 <3.0
- guzzlehttp/guzzle: ^6.2
- incenteev/composer-parameter-handler: >=2.0
Requires (Dev)
- phpunit/phpunit: >=5.0
This package is not auto-updated.
Last update: 2024-11-09 16:58:36 UTC
README
Functional tests will fail until the new server is ready
Framework for creating ARI (Asterisk REST Interface) applications. (https://wiki.asterisk.org/wiki/display/AST/Getting+Started+with+ARI)
Features
- First PHP ARI client to support wss
- Full Asterisk REST Interface support (Tested with 12 and 13)
- Event system at the client and resource level
- Optional basic AMI event/action support
- Verbose for ease of use
- Partial functional tests TODO!
Available via Composer
Just add the package "wormling/phparia":
composer require wormling/phparia
Creating a stasis application
$ariAddress = 'ws://localhost:8088/ari/events?api_key=username:password&app=stasis_app_name'; $logger = new \Zend\Log\Logger(); $logWriter = new \Zend\Log\Writer\Stream("php://output"); $logger->addWriter($logWriter); //$filter = new \Zend\Log\Filter\SuppressFilter(true); $filter = new \Zend\Log\Filter\Priority(\Zend\Log\Logger::NOTICE); $logWriter->addFilter($filter); $this->client = new \phparia\Client\Phparia($logger); $this->client->connect($ariAddress); $this->client->onStasisStart(function(StasisStart $event) { $channel = $event->getChannel(); $bridge = $this->client->bridges()->createBridge(uniqid(), 'dtmf_events, mixing', 'bridgename'); $this->client->bridges()->addChannel($bridge->getId(), $channel->getId(), null); ... }); $this->client->run();
Creating a stasis application and listening for AMI events
$ariAddress = 'ws://localhost:8088/ari/events?api_key=username:password&app=stasis_app_name'; $amiAddress = 'username:password@localhost:5038'; $logger = new \Zend\Log\Logger(); $logWriter = new \Zend\Log\Writer\Stream("php://output"); $logger->addWriter($logWriter); //$filter = new \Zend\Log\Filter\SuppressFilter(true); $filter = new \Zend\Log\Filter\Priority(\Zend\Log\Logger::NOTICE); $logWriter->addFilter($filter); $this->client = new \phparia\Client\Phparia($logger); $this->client->connect($ariAddress, $amiAddress); $this->client->onStasisStart(function(StasisStart $event) { $channel = $event->getChannel(); $bridge = $this->client->bridges()->createBridge(uniqid(), 'dtmf_events, mixing', 'bridgename'); $this->client->bridges()->addChannel($bridge->getId(), $channel->getId(), null); $this->client->getWsClient()->on('SomeAMIEventName', function($event) { ... }); ... }); $this->client->run();
Documentation
You will find wrappers for (https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+ARI) in the Api folder.
You will find wrappers for (https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+REST+Data+Models) in the Resources and Events folders.
Examples
(https://github.com/wormling/phparia/tree/master/src/wormling/phparia/Examples)
(https://github.com/wormling/phparia/tree/master/src/wormling/phparia/Tests/Functional)
Extensions
phparia-lyra Sangoma Lyra Answering Machine Detection for Asterisk.
License
Apache 2.0 (http://www.apache.org/licenses/LICENSE-2.0)