@automat-berlin/node-red-contrib-sipgate 1.0.0

Node-RED nodes for sipgate.io that offer a convenient way to build communications applications (e.g. IVR, lookup dependent call routing) on top of the sipgate API.

npm install @automat-berlin/node-red-contrib-sipgate

This repository contains a collection of nodes which implements sipgate.io API.

This is a community project. sipgate is a registered trademark of sipgate GmbH in Germany and other countries. Automat Berlin GmbH as well as the initial authors of this module are not affiliated with, nor endorsed by, nor connected in any way to sipgate GmbH or any of their subsidiaries.

Installation

Prerequisite: You need to have running Node-RED instance. If you don't have yet, read Node-RED Getting Stared guide.

Install last released version from Node-RED dashboard

The easiest way to install sipgate.io nodes is to use Manage palette option in Node-RED menu (in top right corner of its dashboard). Switch to Install tab and search for @automat-berlin/node-red-contrib-sipgate. There should be only one result. Click install button near by it.

Install from the source code

First clone this repository. Optionally switch to the desired branch.

Next, go to the Node-RED install directory, typically ~/.node-red and install there the cloned package.

cd ~/.node-red/
npm install <path-to-cloned-repository>

Configuration

You should be aware how to configure Node-RED (read the docs here).

Following instructions assume that you are using settings.js file for configuration (found in the user directory or specified with -s command line argument).

Set baseUrl for callbacks

The base URL will be used to create absolute URLs for callbacks (onData, onAnswer, onHangup) required by sipgate.io Push API.

Find functionGlobalContext object and add baseUrl property with the base URL of your Node-RED deployment.

    ...
    functionGlobalContext: {
        baseUrl: 'http://example.com'
    },
    ...

Tests

First, go to the repository's main directory and install all dependencies:

npm install

Then to run all tests use this command:

npm test

Contributing

We welcome all contributions. Please read our contributing guidelines.

Contact us if you have any questions via email info@automat.berlin or create an issue.

Contact

This repository is owned and maintained by Automat Berlin GmbH.

sipgate is a trademark of sipgate GmbH in Germany and in other countries.

License

The code in this repository is released under the MIT license. See LICENSE for details.