opensoft/asterbunny

This tool sends json encoded asterisk ami events to RabbitMQ

AsterBunny

Simple PHP based CLI tool to publish Asterisk AMI events to a Rabbit Message Queue, _(*1)

PHP Versions

Note: PAMI Requires PHP 5.3+. PHP versions 5.3.9 and 5.3.10 WILL NOT WORK due to a bug introduced in stream_get_line() in 5.3.9. Please use 5.3.11+ or up to 5.3.8 (see README.PHP-5.3.9-and-5.3.10)., _(*2)

Install

Clone the repo:, _(*3)

git clone https://github.com/opensoft/AsterBunny.git

Now install dependencies with composer, _(*4)

curl http://getcomposer.org/installer | php
php composer.phar install

Usage

The CLI tool is located at bin/asterbunny and has a lot of configuration options relating to specifying hostnames, ports, usernames, and passwords for Asterisk connections and RabbitMQ servers., _(*5)

It's recommended to run the following to learn the configuration set, and defaults, _(*6)

./bin/asterbunny listen --help

Message Sending

All asterisk events emitted by the Asterisk AMI interface are encoded as JSON and then sent to a configured RabbitMQ server., _(*7)

Specifically, http://www.voip-info.org/wiki/view/asterisk+manager+events are:, _(*8)

1. Keys are converted to lowercase
2. The message is converted to JSON

And then submitted to the configured exchange with the fanout exchange type, _(*9)

Example

{
    "event": "Agentlogoff",
    "agent": "<agent>",
    "logintime": "<logintime>",
    "uniqueid": "<uniqueid>"
}

Message headers are as follows:, _(*10)

• timestamp => The unix timestamp of when the event occured as seen by AsterBunny
• content_type => application\json
• delivery_mode => 2 - Indicates that the message should be persisted by RabbitMQ

Logging

A default log4php configuration file is included with this tool., _(*11)

$ cp log4php.dist.xml log4php.xml

Configure logging by editing the file according to instructions found here, _(*12)

Requirements

• PHP 5.3
• RabbitMQ
• Asterisk AMI

License

AsterBunny is licensed under the MIT License - see the LICENSE file for details, _(*13)

Acknowledgments

• http://github.com/symfony/console
• http://github.com/videlalvaro/php-amqplib
• http://github.com/marcelog/pami