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
• Promises
• Testing
• Examples
• References

npm install @vonage/server-sdk

yarn add @vonage/server-sdk

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

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',
    text: 'This is a test',
});

Run:

npm run test

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

npm run test-watch

See the Vonage Node Quickstarts repo.

You can find more information for each product below:

• Accounts
• Applications
• Audit
• Auth
• JWT
• Messages
• Number Insight V2
• Number Insights
• Numbers
• Pricing
• Server Client
• Server SDK
• SMS
• Sub Accounts
• Verify
• Verify V2
• Vetch
• Video
• Voice

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

The following Network APIs are supported however they are opt-in.

• Number Verification
• SIM Swap

While most of the V2 functions have been ported into their own package, some of the functions have not been ported or were removed. Below is a list of those changes:

For more information, check out each packages migration guide.