npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

adonis-asterisk-ami

v0.2.0

Published

Asterisk AMI client for adonis framework

Downloads

16

Readme

Adonis Asterisk AMI

Easy control via asterisk manager interface (AMI).

Installation and configuration

Using npm:

npm i adonis-asterisk-ami --save

Using yarn:

yarn add adonis-asterisk-ami

Once it's installed, you can register the service provider in bootsrap/app.js in the aceProviders:

const aceProviders = [
  ...
  'adonis-asterisk-ami/providers/AsteriskAmiProvider',
  ...
]

And add commands in commands:

const commands = [
  ...
  'Adonis/Commands/Ami:Listen',
  'Adonis/Commands/Ami:Action',
  'Adonis/Commands/Ami:Dongle:Sms',
  'Adonis/Commands/Ami:Dongle:Ussd'
  ...
]

Then add ami.js file in config folder with this code:

'use strict'

const Env = use('Env')

module.exports = {
  // client's parameters
  reconnect: false,
  maxAttemptsCount: 30,
  attemptsDelay: 1000,
  keepAlive: false,
  keepAliveDelay: 1000,
  emitEventsByTypes: true,
  eventTypeToLowerCase: false,
  emitResponsesById: true,
  addTime: false,
  eventFilter: null,
  // connection parameters
  host: Env.get('ASTERISK_AMI_HOST', '127.0.0.1'),
  port: Env.get('ASTERISK_AMI_PORT', 5038),
  username: Env.get('ASTERISK_AMI_USERNAME', ''),
  secret: Env.get('ASTERISK_AMI_SECRET', ''),
  dongle: {
    sms: {
      device: Env.get('ASTERISK_AMI_SMS_DEVICE', 'dongle1')
    }
  }
}

For more information abount client's parameters see documentation.

Usage

Connection options

You are can specify connection parameters for all commands.

| Option | Description | | --------- | ---------------------------- | | --host | Asterisk AMI server host | | --port | Asterisk AMI server port | | --username | Asterisk AMI server username | | --secret | Asterisk AMI server secret |

Listen ami events

./ace ami:listen
// app/Listeners/AsteriskAmi.js
'use strict'

const AsteriskAmi = exports = module.exports = {}

AsteriskAmi.onEvent = function * (event) {
  console.log(`${event.Event} handled`)
}

// bootsrap/events.js
...
Event.when('ami.events.*', 'AsteriskAmi.onEvent')
...

For more information about event property see asterisk-ami-client documentation.

If would you like to see event log in the console use debug option

./ace ami:listen --debug

Send ami action

./ace ami:action <action> --props='<key1>:<value1>;<key2>:<value2>' --id=<UNIQUE_ID?>
const props = _.reduce({
  <key>: <value>,
  <key2>: <value2>
}, (result, value, key) => {
  if (result.length) {
    result = `${result};`
  }
  result += `${key}:${value}`
  return result
}, '')

// Foo:Bar,ActionID:<UNIQUE_ID?>
Ace.call('ami:action', [<action>], {
  props,
  id: <UNIQUE_ID?>
});

Options props and id is not required.

Send sms messages using chan dongle

./ace ami:dongle:sms <phone> <message> <device?> --id=<UNIQUE_ID?>
Ace.call('ami:dongle:sms', [
  <phone>,
  <message>,
  <device?>,
], {
  id: <UNIQUE_ID?>
});

For sending long messages use pdu mode.

./ace ami:dongle:sms <phone> <message> <device?> --pdu --id=<UNIQUE_ID?>
Ace.call('ami:dongle:sms', [
  <phone>,
  <message>,
  <device?>,
], {
  pdu: true,
  id: <UNIQUE_ID?>
});

Argument device and option id is not required.

Send ussd commands using chan dongle

./ace ami:dongle:ussd <device> <ussd> --id=<UNIQUE_ID>
Ace.call('ami:dongle:ussd', [
  <ussd>,
  <device>
], {
  id: <UNIQUE_ID>
});

Option id is not required.

Without Adonis App

See bin folder

Credits

Support

Having trouble? Open an issue!

License

The MIT License (MIT). Please see License File for more information.