ofbeaton/phpami

Asterisk Manager Interface (AMI) for PHP 5.4+ supporting legacy v1.4 to v13 with no thrills.

phpami

Asterisk Manager Interface (AMI) for PHP 5.4+ supporting legacy v1.4 to v13 with no thrills., _(*1)

This is a fork and update of the AMI portion of the now defunc PHPAGI PHP 4.4 project which has not been updated since 2010., _(*2)

We have kept the simplicity of a single class with command methods, adding a packagist entry and namespaces. This is a breaking change as class and method names have changed to follow modern standards, however they are a 1:1 mapping so updating your code should be straight forward., _(*3)

Alternatives

If you are dealing with only Asterisk v13+ servers, consider using PAMI instead, which uses modern design paterns with observer-listener pattern. It no longer supports legacy Asterisk versions like v1.4 however. It may also see less development than the NAMI library for NodeJS., _(*4)

Updates

The project is considered in a usable state and feature complete., _(*5)

This project is used in corporate applications. As such, the authors are unlikely to update it on a regular basis, but instead when the corporate applications that use it run into problems. You should expect updates in the 5-10yr range., _(*6)

Issues and PRs will be monitored, and we will continue to work with the community to provide updates as they are contributed., _(*7)

Installing via Composer

The recommended way to install PHPAMI is through Composer., _(*8)

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version:, _(*9)

composer.phar require ofbeaton/phpami

After installing, you can now use it in your code:, _(*10)

   $ami = new \PHPAMI\Ami();
   if ($ami->connect('localhost:5038', 'myuser', 'mysecret', 'off') === false) {
      throw new \RuntimeException('Could not connect to Asterisk Management Interface.');
   }

   // // if you have a looping of command function
   // // set allowTimeout flag to true
   // $ami->allowTimeout();

   // $result contains the output from the command
   $result = $ami->command('core show channels');

   $ami->disconnect();

License

This software is distributed under the LGPL 2.1 License. Please see License file for more information., _(*11)

This library is a fork of the now defunc PHPAGI project by Matthew Asham. See Fork release for more details., _(*12)