Skip to main content
The official Node.js SDK for the Vobiz Voice API. Make calls, manage SIP trunks, handle CDR, record calls, configure phone numbers, and more - all natively from your Node.js or TypeScript backend. Source code: vobiz-ai/Vobiz-Node-SDK

Installation

The SDK is distributed from its GitHub repo (not a package registry). Install it straight from GitHub; the package builds itself on install:
Requires Node.js 18 or newer.

Quick start

Make an outbound call:
Resources and client namespaces are camelCase (e.g. client.liveCalls), while request body fields are snake_case (e.g. auth_id, answer_url). All methods return a Promise.

Authentication

All API calls require your Auth ID and Auth Token, available in the Vobiz Console. Pass them when constructing the client - apiKey maps to your Auth ID and authToken to your Auth Token:
We recommend keeping credentials out of source by reading them from environment variables:

Common operations

All snippets assume client and authId are initialized as shown above.

Live calls

In-call actions

Call detail records (CDR)

Conferences

Phone numbers and balance

VobizXML

When a call is answered, Vobiz fetches your answer_url and expects VobizXML describing the call flow. The SDK bundles a vobizxml builder so you can construct it programmatically - it handles escaping and validation:
Gather uses inputType and executionTimeout (not timeout). The timeout attribute belongs to Dial/Number elements only.

Alternative: raw XML

You can also return hand-written VobizXML directly if you prefer:

Messaging (SMS, MMS and RCS)

The Node.js SDK includes the full Vobiz Messaging API under client.sms. Send a message with the client you created above:
Every Messaging operation has a matching method, for example client.sms.messages.previewMessageCost and client.sms.numbers.listNumbers. See Messaging in the SDKs for the full method list and error handling; each Messaging API reference page shows a complete Node.js example.

Resources