Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 1.87 KB

README.md

File metadata and controls

71 lines (51 loc) · 1.87 KB
Raw

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