asteriskagi

Asterisk AGI (FastAGI) Server for Nodejs

Overview

Event-based server useful for building Asterisk FastAGI applications in Nodejs. Each call produces a "call" event containing a call handle you can interact with to get variables, perform actions, etc.

Features

• Event-driven
• Compatible with Asterisk AGI(agi://)

Getting Started

Installation

Using NPM:

$ npm install asteriskagi

Basic Usage

import AGIServer from "asteriskagi";

const agi = new AGIServer(/* {port: 4573} */); // Server (optional port, default: 4573)

agi.on("call", async (call) => {
  const { remoteServer, uniqueid, context, extension, priority, calleridname, callerid, channel } = call;
  const isHangup = (err) => err?.code === "AGI_HANGUP";

  call.once("hangup", () => {
    console.log(`Hangup  ${remoteServer}/${channel}`);
  });

  try {
    await call.Answer();
    await call.Playback("beep");
    await call.SayAlpha("hello");
  } catch (err) {
    if (!isHangup(err)) {
      console.error(`ERROR: ${callLabel}:`, err);
    }
  } finally {
    if (!call.hungup) {
      try {
        await call.Hangup();
      } catch (err) {
        if (!isHangup(err)) {
          console.error(`HANGUP ERROR: ${callLabel}:`, err);
        }
      }
    }
    /* CDR operations */
  }
});

In Asterisk dialplan (assuming the Node server is running on the same machine):

exten => 1234,1,AGI(agi://localhost:4573)

Commands

All standard Asterisk dialplan commands (as of 20.x) are accessible via the call object. (See 'Basic Usage' for examples.)

Events

Warning

Make sure to handle clean up of in-call event listeners to prevent memory leaks.

AGIServer Events

Event	Description
call	Emitted when a call arrives. Contains the "call" object.
ready	Emits when the server is listening and ready.
error	Emitted when an error occurs. (err) = "Errror text"

Call Events

Event	Description
hangup	Emitted when a call disconnects.
error	Emitted when an error occurs. (err) = "Errror text"