Socket
Socket
Sign inDemoInstall

@vonage/server-sdk

Package Overview
Dependencies
64
Maintainers
44
Versions
78
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vonage/server-sdk

Node.js Client for the Vonage API Platform


Version published
Maintainers
44
Weekly downloads
34,925
decreased by-9.49%

Weekly downloads

Readme

Source

Vonage Server SDK for Node.js

GitHub Workflow Status Codecov Latest Release Contributor Covenant License

Vonage

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

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',
    text: '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.

References

You can find more information for each product below:

Supported APIs

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

APIAPI Release StatusSupported?
Account APIGeneral Availability
Alerts APIGeneral Availability
Application APIGeneral Availability
Audit APIBeta
Conversation APIBeta
Dispatch APIBeta
External Accounts APIBeta
Media APIBeta
Messages APIBeta
Number Insight V2 APIBeta
Number Insights APIGeneral Availability
Number Management APIGeneral Availability
Pricing APIGeneral Availability
Proactive Connect APIBeta
Redact APIDeveloper Preview
Reports APIBeta
SMS APIGeneral Availability
Sub AccountsBeta
UsersGeneral Availability
Verify APIGeneral Availability
Verify v2 APIGeneral Availability
Video APIGeneral Availability
Voice APIGeneral Availability

V2 Migrations

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:

V2 FunctionStatusNote
vonage.conversionREMOVED
vonage.conversationNot ImplementedThis was only released as a beta package
vonage.appMovedMoved to Applications
vonage.filesMovedMove to ServerClient
vonage.messageMovedMoved to SMS
vonage.generateJwtMovedWas moved to JWT
vonage.generateSignatureMovedWas moved to SMS and Voice
vonage.callsMovedWas moved to Voice
vonage.credentialsUpdatedOptions can be found in Server Client
vonage.optionsUpdatedOptions can be found in Server Client
vonage.options.httpClientRemoved
vonage.options.userAgentMovedOptions can be found in Server Client

For more information, check out each packages migration guide.

FAQs

Last updated on 21 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc