Skip to content
/ awry Public
forked from chadxz/awry

An ARI websocket and API client library

License

Notifications You must be signed in to change notification settings

GolDiV/awry

 
 

Repository files navigation

awry

Build Status Codecov Greenkeeper Badge

An Asterisk REST Interface websocket and API client library for node.js v6+.

installation

npm install awry

usage

const awry = require('awry');

const api = new awry.API({
  baseUrl: 'http://asterisk.local:8088/ari',
  username: 'asterisk',
  password: 'asterisk'
});

api.applications.list().then(apps => {
  console.log(apps);
});

const events = awry.Events.connect({
  app: 'someApp',
  url: 'http://asterisk.local:8088/ari/events',
  username: 'asterisk',
  password: 'asterisk'
});

events.on('message', message => {
  console.log(message);
});

For more details see the full API documentation.

debugging

awry uses the debug module to log debugging output. To enable this output to print to the console, set the environment variable DEBUG to one of the following when running your app:

  • awry:* - shows all debug output from this library.
  • awry:ARIWebSocket - shows only the debug output from the ARIWebSocket sub-module.
  • awry:ReconnectingWebSocket - shows only the debug output from the ReconnectingWebSocket sub-module.

For example: DEBUG=awry:* node myapp.js

contributing

See CONTRIBUTING.md.

license

MIT

About

An ARI websocket and API client library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%