@vonage/server-sdk

Vonage Server SDK for Node.js

This is the Node.JS Server SDK for Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.

For full API documentation refer to developer.vonage.com.

• Installation
• Constructor
• Callbacks
• Testing
• Examples
• Supported APIs
• References

Installation

With NPM

npm install @vonage/server-sdk

With Yarn

yarn add @vonage/server-sdk

Constructor

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage(credentials, options);

Where credentials is any option from @vonage/auth, and options is any option from @vonage/server-client

Promises

Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use await to wait for a response.

const resp = await vonage.sms.send({
    to: '15552220000',
    from: '15559992222',
    'This is a test',
});

Testing

Run:

npm run test

Or to continually watch and run tests as you change the code:

npm run test-watch

Examples

See the Vonage Node Quickstarts repo.

Supported APIs

The following is a list of Vonage APIs and whether the Node Server SDK provides support for them:

API	API Release Status	Supported?
Account API	General Availability	✅
Alerts API	General Availability	✅
Application API	General Availability	✅
Audit API	Beta	❌
Conversation API	Beta	❌
Dispatch API	Beta	❌
External Accounts API	Beta	❌
Media API	Beta	❌
Messages API	Beta	❌
Number Insight API	General Availability	✅
Number Management API	General Availability	✅
Pricing API	General Availability	✅
Redact API	Developer Preview	❌
Reports API	Beta	❌
SMS API	General Availability	✅
Verify API	General Availability	✅
Voice API	General Availability	✅

References

You can find more information for each product below:

• Accounts
• Applications
• Auth
• JWT
• Messages
• Number Insights
• Numbers
• Pricing
• Server Client
• SMS
• Verify
• Vetch
• Video
• Voice