monipy v0.7.1

MONIPY Client JS SDK for Voice

MONIPY Supervisor JS SDK allows you to barge into an ongoing call.

Get Started

Installation

You can install MONIPY using npm:

npm i monipy

Initializing the MONIPY SDK Object

The MONIPY SDK object needs to be initialized.

var monipy = new MONIPY( {
        name: 'Kiara',
        debug: false,
        autoplay: true,
        autoReboot: false,
        ringTime: 60
    } );

Configuration Parameters

Below are the configuration parameters:

Login

Validate your login ID and password.

monipy.login('YOUR_LOGIN_ID','YOUR_PASSWORD');

Event Listeners

monipy.on( 'login', function ( object ) {
    console.log( object );
} );

monipy.on( 'logout', function ( object ) {
    console.log( object );
} );

monipy.on( 'loginFailed', function ( object ) {
    console.log( object );
} );

monipy.on( 'error', function ( object ) {
    console.log( object );
} );

monipy.on( 'ended', function ( object ) {
    console.log( object );
} );

monipy.on( 'rejected', function ( object ) {
    console.log( object );
} );

monipy.on( 'answered', function ( object ) {
    console.log( object );
} );

monipy.on( 'hangup', function ( object ) {
    console.log( object );
} );

monipy.on( 'mediaFailed', function ( object ) {
    console.log( object );
} );

monipy.on( 'inComingCall', function ( object ) {
    console.log( object );
    monipy.answer();
} );

monipy.on( 'ringing', ( e ) => {
    console.log( e );
} );

monipy.on( 'dtmf', ( e ) => {
    console.log( e );
} );

monipy.on( 'hold', ( e ) => {
    console.log( e );
} );

monipy.on( 'unhold', ( e ) => {
    console.log( e );
} );

monipy.on( 'missed', ( e ) => {
    console.log( e );
} );

monipy.on( 'trying', ( e ) => {
    console.log( e );
} );

monipy.on( 'callStream', ( e ) => {
    console.log( e );
} );

HTTP status codes

MONIPY platform represents the following status codes to identify errors.

Answer Call

Answer an incoming call.

monipy.answer();

HTTP status codes

Reject Call

Reject an incoming call.

monipy.reject();

HTTP status codes

Terminate Call

Hang up the ongoing call.

monipy.terminate();

HTTP status codes

Logout

Logout from the MONIPY SDK.

monipy.logout();

HTTP status codes