Vonage Proactive Connect SDK for Node.js

[!WARNING] Starting on August 31st 2024, This API is sunset and will be removed in the next major release.

This is the Vonage Proactive Connect SDK for Node.js for use with 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
• Usage
• Promise
• Testing
• Supported APIs

Installation

With NPM

npm install @vonage/proactive-connect

With Yarn

yarn add @vonage/proactive-connect

Usage

Unlike the other SDK's this package is not include in the Vonage Server SDK for Node.js

You only need to use the Proactive Connect APIs. All you need to do is require('@vonage/proactive-connect'), and use the returned object to create your own client.

const { Auth } = require('@vonage/auth');
const { ProactiveConnect } = require('@vonage/proactive-connect');

const credentials = new Auth({
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
});
const options = {};
const proactiveConnectClient = new ProactiveConnect(credentials, options);

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

Promises

This SDK uses Promises to return data.

(async () =>{
  for await (const list of proactiveConnectClient.findAllLists()) {
    console.log(list);
  }
})();

Testing

Run:

npm test

Supported APIs

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

| API | Supported? | |-------------|:-----------:| | Lists | ✅ | | Items | ✅ | | Action | ❌ | | Jobs | ❌ | | Runs | ❌ | | Events | ✅ |