ivr-api

An API for retrieving IVR menu data using the NUM Protocol.

Installation For Local Testing

• git clone [email protected]:NUMtechnology/ivr-api.git
• cd ivr-api
• npm install
• Open test/index.html in your browser.

Installation For Use In An Application

• npm install -s ivr-api

Simple Application Usage in TypeScript

import { createIVRApi } from 'ivr-api';

// Create an API instance
const api = createIVRApi();

// Use it to look up a phone number
api.lookupPhoneNumber('+448000683827').then((result) => {
  console.log(JSON.stringify(result));
});

Simple Application Usage in JavaScript

const ivrapi = require('ivr-api');

// Create an API instance
const api = ivrapi.createIVRApi();

// Use it to look up a phone number
api.lookupPhoneNumber('+448000683827').then((result) => {
  console.log(JSON.stringify(result));
});

Controlling the Recursion Levels in TypeScript

import { createIVRApi, IVRApiOptions } from 'ivr-api';

// Create an API instance
const api = createIVRApi();

const options = new IVRApiOptions(
    2// The number of levels for IVR records. 0 returns no data.
  );

// Use it to look up a phone number
api.lookupPhoneNumber('+448000683827', options).then((result) => {
  console.log(JSON.stringify(result));
});

Supplying an Existing NUMClient Object in TypeScript

If you already have a NUMClient object you can re-use it.

import { createClient } from 'num-client';
import { createIVRApi } from 'ivr-api';

// (from another part of your application)
const existingClient = createClient();

// Inject the existing client when creating the API instance
const api = createIVRApi(existingClient);

// Use it to look up a phone number
api.lookupPhoneNumber('+448000683827').then((result) => {
  console.log(JSON.stringify(result));
});