asterisk-ami
An extremely lightweight Asterisk AMI connector
Install
npm install asterisk-ami
Usage
var AsteriskAmi = ;var ami = host: 'hostname' username: 'username' password: 'secret' ; ami; ami;//connect creates a socket connection and sends the login action ami;
Events
(AMI Data) These give you AMI specific information
- ami_login Called when logging into the ami, no data passed back
- ami_data Called for each event we get back from the AMI, with an object being returned
(net socket events) Use these events to determine the status of the socket connection, as if the socket is disconnected, you would need to add your .on('close') events again, this was a bug in the previous version of asterisk-ami, use these new events instead which will always be called, even if the connection has died and been reconnected.
- ami_socket_drain
- ami_socket_error
- ami_socket_timeout
- ami_socket_end
- ami_socket_close
- ami_socket_unwritable
methods
//logs out of the AMI and then closes the connection, sets reconnect to false so that it wont try and reconnect //send an ami call, pass in a javascript object with the params you want to send the ami //terminates the connection to the ami socket if say disconnect fails, or you've lost connection to the ami and you're not using reconnect: true as a param
Configuration options
AsteriskAmi has preset/configurable options, you can set these via an object passed in to AsteriskAmi
- port: Port number for Asterisk AMI, default
5038
- host: Host of Asterisk, default
localhost
- username: Username of Asterisk AMI user, default:
username
- password: Password of Asterisk AMI user, default:
password
- debug: Do you want debugging output to the screen, default:
false
- reconnect: Do you want the ami to reconnect if the connection is dropped, default:
false
- reconnect_after How long to wait to reconnect, in miliseconds, default:
3000
- events Do we want to recieve AMI events, default:
true
NPM Maintainers
The npm module for this library is maintained by:
License
asterisk-ami is licensed under the MIT license.