Skip to content

The official Node.js library for sipgate.io

License

Notifications You must be signed in to change notification settings

sipgate-io/sipgateio-node

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
sipgateio-team
Mar 31, 2020
a8da75c · Mar 31, 2020
Mar 26, 2020
Mar 31, 2020
Mar 31, 2020
Feb 11, 2020
Feb 12, 2020
Feb 13, 2020
Mar 25, 2020
Aug 20, 2019
Mar 31, 2020
Feb 12, 2020
Mar 31, 2020
Mar 31, 2020
Feb 13, 2020
Mar 26, 2020

Repository files navigation

sipgateio-node Build Status

A JavaScript library for sipgate.io

Get Started

Installation

For use in node applications you can install with

npm install sipgateio --save

Alternatively, a bundled version can be obtained from the github releases page.
Or use a CDN like jsDelivr instead:
https://cdn.jsdelivr.net/gh/sipgate-io/sipgateio-node@v1.4.0/bundle/sipgate-io.min.js

Available Functionality

The following features are already implemented in the current version of this library:

SMS

Send text messages, either instantly or scheduled. The caller ID can be set from the sipgate web interface, the default is the string "sipgate".

Fax

Send any PDF file as a fax to a single number.

Call

Initiate a call between two phones of your choice – no matter if inside your sipgate account or outside.

Webhook (node.js only)

Set up a webserver to process real-time call data from sipgate.io.

Webhook Settings

Configure the webhook functionality of sipgate.io. Currently, you can set URLs and whitelist extensions for triggering webhooks as well as toggle the debug log.

Contacts

Import contacts in CSV format into your sipgate account.

Usage

Creating a Client

You can connect the client by passing a valid OAuth token (You have to implement the OAuth flow yourself):

const client = sipgateIO({
	token: '<valid Token>',
});

As alternative you can also pass your credentials to the API-Client which will use Basic Auth. (Remember: This way is not recommended)

const client = sipgateIO({
	username: '<your username>',
	password: '<your password>',
});

Possible authentication objects:

interface BasicAuthCredentials {
	username: string;
	password: string;
}
interface OAuthCredentials {
	token: string;
}

The sipgateIO method accepts your valid sipgate credentials as defined in the AuthCredentials type and returns a sipgate.io Client. The client contains as members the supported modules (sms, fax, call, etc.).

SMS

The SMS module provides the following functions:

async function send(sms: ShortMessage): Promise<void>;
async function schedule(sms: ShortMessage, sendAt: Date): Promise<void>;

Note: sendAt can be 30 days in advance at max.

Note: you should be aware that the request will take a short time to be processed. Values for sendAt should not just be a few seconds in the future. If sendAt is in the past an error will be thrown.

The ShortMessage type requires the following fields:

interface ShortMessage {
	smsId: string;
	to: string;
	message: string;
}

or

interface ShortMessage {
	from: string;
	to: string;
	message: string;
}

Fax

The fax module provides the following functions:

async function send(fax: Fax): Promise<SendFaxSessionResponse>;
async function getFaxStatus(sessionId: string): Promise<FaxStatus>;

The send function allows you to send a fax by passing an object with the following fields:

interface Fax {
	to: string;
	fileContent: Buffer;
	filename?: string;
	faxlineId?: string;
}

and returns an SendFaxSessionResponse:

interface SendFaxSessionResponse {
	sessionId: string;
}

By using getFaxStatus and passing the sessionId you received from the send function, you will receive one of the following values:

enum FaxStatus {
	SENT = 'SENT',
	PENDING = 'PENDING',
	FAILED = 'FAILED',
	SENDING = 'SENDING',
	SCHEDULED = 'SCHEDULED',
}

Call

The call module provides the following function:

async function initiate(
	newCallRequest: CallData
): Promise<InitiateNewCallSessionResponse>;

The CallData contains the following fields:

interface CallData {
	deviceId?: string;
	from: string;
	to: string;
	callerId?: string;
}

The InitiateNewCallSessionResponse contains only a session ID:

interface InitiateNewCallSessionResponse {
	sessionId: string;
}

CallData details

The following table shows valid parameter combinations

to from callerId deviceId
number extension - -
number extension number -
number extension number extension
number number - extension
number extension - extension
number number number extension

The displayed number at the callee device is determined by a hierarchy:

If not set it falls back to the next stage:

  1. callerId
  2. deviceId (related phone number)
  3. from (related phone number if from is an extension)

The param deviceId is only mandatory if from is not an extension.

Valid extension types are e, p, x and y.

extension type phone type
e VoIP phone
p user phoneline
x external phone
y mobile phone

Scenario 1: basic call

const call = createCallModule(client);
const callData = {
	from: 'e14',
	to: '+4921165432',
};

call.initiate(callData);

Behavior: The phone with extension e14 rings first, after pick-up the callee is called. The default number associated with e14 is displayed at the callee device.

Scenario 2: custom caller id

const callData = {
	from: 'p0',
	to: '+4921165432',
	callerId: '+4917012345678',
};

call.initiate(callData);

Behavior: Same situation as previous example, but displayed number is now callerId (see hierarchy).

Scenario 3: group call

const callData = {
	from: '+4921123456',
	deviceId: 'e14',
	to: '+4921165432',
};

call.initiate(callData);

If the from number refers to a group of phones rather than a single one all phones in the group will ring and the first to be picked up will establish the call with the to.

The deviceId is needed for billing and determines the number which will be displayed at the to device. For instance, e14 has the default number '+4921156789'.

Webhooks

Please note: The webhook feature is only available in node.js environments.

What is a webhook?

The Webhook API provides processing of real-time call data.
A webhook is a POST request that sipgate.io makes to a predefined URL when a certain event occurs. These requests contain information about the event that occurred in application/x-www-form-urlencoded format.

The webhook module provides a simple means to set up a server for handling these webhooks.

The following types of events can trigger webhooks:

EventType Description
NEW_CALL signals that a new call is ringing
ANSWER signals that the call has been answered
HANGUP signals that the call has been hung up
DATA signals dtmf tones sent in the call

For any of those events, a callback function can be registered to be called upon receiving the respective webhook.

Additionally, for the types NEW_CALL and DATA a response may be returned containing commands to trigger actions like hanging up or redirecting calls.

For generating that response our library provides a convenient response builder.

Usage

To begin, instantiate the webhook module by calling createWebhookModule. The resulting object provides only one method, createServer which takes a configuration object of type ServerOptions containing a port number, server address, and an optional hostname (default: localhost). It returns a Promise<WebhookServer> which, when started, provides the following methods:

interface WebhookServer {
	onNewCall: (fn: HandlerCallback<NewCallEvent, ResponseObject | void>) => void;
	onAnswer: (fn: HandlerCallback<AnswerEvent, void>) => void;
	onHangup: (fn: HandlerCallback<HangUpEvent, void>) => void;
	onData: (fn: HandlerCallback<DataEvent, ResponseObject | void>) => void;
	stop: () => void;
}

The stop method simply kills the server, the other methods each take a callback function for handling the respective types of events suggested by their name.

Registering event callbacks

Each of the four callback registration methods takes a single callback function that accepts a webhook object of the respective type (i.e. NewCallEvent, AnswerEvent, HangUpEvent, or DataEvent). In the case of onNewCall and onData the provided function may return a ResponseObject (details below)

Within the callback function the following fields are accessible:

All event types

In all callback functions there is a common subset of available fields:

interface GenericCallEvent {
	callId: string;
	direction: Direction;
	from: string;
	to: string;
	xcid: string;
}
onNewCall

In addition the NewCallEvent type offers the following fields:

interface NewCallEvent extends GenericCallEvent {
	event: EventType.NEW_CALL;
	originalCallId: string;
	user: string[];
	userId: string[];
	fullUserId: string[];
}
onAnswer

the AnswerEvent type offers the following fields:

interface AnswerEvent extends GenericCallEvent {
	event: EventType.ANSWER;
	user: string;
	userId: string;
	fullUserId: string;
	answeringNumber: string;
	diversion?: string;
}
onHangUp

the HangUpEvent type offers the following fields:

interface HangUpEvent extends GenericCallEvent {
	event: EventType.HANGUP;
	cause: HangUpCause;
	answeringNumber: string;
}
onData

the DataEvent type offers the following fields:

interface DataEvent extends Event {
	event: EventType.DATA;
	dtmf: string; // Can begin with zero, so it has to be a string
}

Sending a response

For composing an XML response from withing a callback function our library offers a convenient response builder:

interface WebhookResponseInterface {
	redirectCall: (redirectOptions: RedirectOptions) => RedirectObject;
	sendToVoicemail: () => VoicemailObject;
	rejectCall: (rejectOptions: RejectOptions) => RejectObject;
	playAudio: (playOptions: PlayOptions) => PlayObject;
	gatherDTMF: (gatherOptions: GatherOptions) => GatherObject;
	hangUpCall: () => HangUpObject;
}
Redirecting calls

The redirectCall method accepts an options object of type RedirectOptions with the following fields:

type RedirectOptions = {
	numbers: string[];
	anonymous?: boolean;
	callerId?: string;
};
Sending calls to voicemail

The sendToVoicemail method accepts no further options.

Rejecting calls

The rejectCall method accepts an options object of type RejectOptions with a single field, the reason for rejecting the call. This reason may be one of the following:

enum RejectReason {
	BUSY = 'busy',
	REJECTED = 'rejected',
}
Play audio

The playAudio method accepts an options object of type PlayOptions with a single field, the URL to a sound file to be played.

Note: Currently the sound file needs to be a mono 16bit PCM WAV file with a sampling rate of 8kHz. You can use conversion tools like the open source audio editor Audacity to convert any sound file to the correct format.

Linux users might want to use mpg123 to convert the file:

mpg123 --rate 8000 --mono -w output.wav input.mp3
Gather DTMF tones

The gatherDTMF method accepts an options object of type GatherOptions with the following fields:

type GatherOptions = {
	announcement?: string;
	maxDigits: number;
	timeout: number;
};

maxDigits specifies to maximum number of DTMF tones to be gathered, the timeout is the period in milliseconds to wait for DTMF input from a caller before processing. Please note that the establishment of the call is delayed until this period has elapsed. By specifying a URL to a sound file as announcement an audio message can be played to inform callers what DTMF tones they should send.

Note: Please consider the above restrictions concerning the format of the announcement file.

Hang up calls

The hangUpCall method accepts no further options.

Webhook Settings

The webhook settings module provides the following functions to update settings:

async function setIncomingUrl(url: string): Promise<void>;
async function clearIncomingUrl(): Promise<void>;

These two functions allow for the setting and clearing of the URL to be called when a webhook is triggered by an incoming call.

async function setOutgoingUrl(url: string): Promise<void>;
async function clearOutgoingUrl(): Promise<void>;

Analogous functions exist for the URL that handles outgoing calls.

async function setWhitelist(extensions: string[]): Promise<void>;
async function clearWhitelist(): Promise<void>;
async function disableWhitelist(): Promise<void>;

The whitelist specifies extensions that should trigger webhooks. By default, webhooks are enabled for all phoneline and group extensions. This behavior is restored by calling disableWhitelist. The disableWhitelist completely removes the whitelisting and enables all phoneline and group extensions.

async function setLog(value: boolean): Promise<void>;

The setLog function toggles, the function to display all incoming and outgoing events, which have been sent to your Incoming and Outgoing Url. These parameters can be set using these functions: setIncomingUrl and setOutgoingUrl.

Contacts

The contacts module provides the following functions:

interface ContactImport {
	firstname: string;
	lastname: string;
	address?: Address;
	phone?: PhoneNumber;
	email?: Email;
	organization?: string[];
}

interface ContactsModule {
	import: (contact: ContactImport, scope: Scope) => Promise<void>;
	importFromCsvString: (csvContent: string) => Promise<void>;
	importVCardString: (vcardContent: string, scope: Scope) => Promise<void>;
	exportAsCsv: (scope: ExportScope, delimiter?: string) => Promise<string>;
	exportAsVCards: (scope: ExportScope) => Promise<string[]>;
	exportAsSingleVCard: (scope: ExportScope) => Promise<string>;
	exportAsObjects: (scope: ExportScope) => Promise<ContactRequest[]>;
}

The import method:

It takes a valid ContactImport Object and creates a Contact in the requested Scope.

The importFromCsvString method:

It takes a valid CSV-formatted string (columns separated by ",") containing at least the following fields:

  • firstname
  • lastname
  • number

These fields may be provided in an arbitrary order. Additional fields as well as empty lines will be ignored. Empty records (i.e. just separators) produce a warning but no error. The same is true for strings containing only the header row.

Example:

lastname,firstname,number
Turing,Alan,+4921163553355
Lovelace,Ada,+4921163553355

The importVCardString method:

It takes a valid VCard 4.0 string, containing at least the following fields:

  • name contains firstname and lastname
  • number

The exportAsCsv method:

It returns a csv strings containing all contacts for the given scope.
You can also add a specific delimiter for the csv format.

The exportAsVCards method:

It returns mulitple vCard-strings containing all contacts for the given scope

The exportAsSingleVCard method:

It returns a vCard-address-book containing all contacts for the given scope

The exportAsObjects method:

It returns a list of contacts for the given scope as described in the following interface.

interface ContactRequest {
	id: string;
	name: string;
	picture: string;
	emails: { email: string; type: string[] }[];
	numbers: { number: string; type: string[] }[];
	addresses: Address[];
	organization: string[][];
	scope: Scope;
}

Scopes

The PRIVATE Scope contains all contacts created by yourself and not shared with other people.

The SHARED Scope includes all contacts created by anyone in your organization and are therefore shared with other people.

The INTERNAL Scope contains the contacts which are created by sipgate such as a contact for any webuser in your organization.

Adress and Numbers:

You can only save one address and one number using the Format.

Examples

For some examples on how to use the library, please refer to this repository: sipgateio-node-examples

npx ts-node some_example.ts

Privacy Note

This library sets the following headers for every request made to the sipgate REST-API to obtain statistics about versions currently in use and to differentiate sipgate.io-users from sipgate software:

  • X-Sipgate-Client
  • X-Sipgate-Version