Node.js SDK

Links

The Node.js SDK(s) are available via NPM & GitHub.

Links	Description	Github
@bandwidth/numbers	Manage phone numbers and account settings
@bandwidth/voice	Create outbound phone calls and manage call media (recordings/transcriptions)
@bandwidth/bxml	Create BXML for managing call flow	N/A
@bandwidth/messaging	Create outbound messages and manage message media (MMS)
@bandwidth/mfa	Create Multifactor Auth calls or messages
@bandwidth/webrtc	Create and manage WebRTC Sessions	N/A
Code Examples	NodeJS code examples

Release notes

Messaging

Voice API

BXML

Note: Starting with @bandwidth/voice 2.0.0, BXML is no longer required as a separate library.

Numbers

MFA

WebRTC

Download & Install

npm install @bandwidth/messaging
npm install @bandwidth/voice

Create Phone Call

import { Client, ApiController } from '@bandwidth/voice';

const client = new Client({
    basicAuthPassword: 'password',
    basicAuthUserName: 'username'
});

const controller = new ApiController(client);

const accountId = '1111111';

const response = await controller.createCall(accountId, {
    applicationId: 'abc12345-6def-abc1-2345-6defabc12345',
    from: '+19999999999',
    to: '+18888888888',
    answerUrl: 'https://your-server.com/webhooks/answer',
    answerMethod: 'POST',
    callTimeout: 30
});

console.log(response);

Generate BXML

import { SpeakSentence, Response } from '@bandwidth/voice';

const speakSentence = new SpeakSentence({
    sentence: 'This is a spoken test.',
    locale: 'en_US'
    voice: 'susan',
    gender: 'female'
});

const response = new Response(speakSentence);

console.log(response.toBxml());

Send Text Message

import { Client, ApiController } from '@bandwidth/messaging';

const client = new Client({
    basicAuthPassword: 'password',
    basicAuthUserName: 'username'
});

const controller = new ApiController(client);

const accountId = '1111111';

const response = await controller.createMessage(accountId, {
    applicationId: 'abc12345-6def-abc1-2345-6defabc12345',
    to: ['+19999999999'],
    from: '+18888888888',
    text: 'The quick brown fox jumps over the lazy dog.'
});

console.log(response);