# @vonage/proactive-connect

> Send large scale outreach campaigns using any channels available through the Vonage APIs

Latest version **1.11.0** (published 2024-09-03) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @vonage/proactive-connect
pnpm add @vonage/proactive-connect
yarn add @vonage/proactive-connect
bun add @vonage/proactive-connect
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.11.0 |
| Published | 2024-09-03 |
| First published | 2023-05-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 121.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 396 |
| Maintainers | mprabhu1, gpojula, omrizilber, elimenko.vonage, thealmoggvonage, saurabh.vonage, aviadhouri.va, daniel-sapir, llihovodov, tabdullah, jmoramunoz2, sailusha, hilakl, leppelin, molszewski_v, twilliams253, abolles, lallen2, yonatan.kra, jtiet, vonage-frontier, vonage_client_media_processing, or.cpc, jeffswartz, deliajolt, liranbin, javiermolsanz, v-kpheng, vgai-dev, web-il, iceberg-team, unified_portal, vreporter-npm, vbcbe, voxip_team, yuri.guller, idanvon, nexmo-devrel, vvd, vonagemeetings, vonage-jenkins, maikthomas, arivonage |

## Links

- npm: https://www.npmjs.com/package/@vonage/proactive-connect
- Repository: https://github.com/Vonage/vonage-node-sdk
- Homepage: https://github.com/vonage/vonage-node-sdk/tree/main/packages/proactive-connect#readme
- Issues: https://github.com/Vonage/vonage-node-sdk/issues
- npm.io page: https://npm.io/package/@vonage/proactive-connect

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) 4.3.6
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [lodash.pick](https://npm.io/package/lodash.pick.md) 3.1.0
- [@vonage/vetch](https://npm.io/package/@vonage/vetch.md) ^1.8.0
- [@vonage/server-client](https://npm.io/package/@vonage/server-client.md) ^1.14.0

## Recent versions

- 1.11.0 (latest) — 2024-09-03
- 1.1.0 (beta) — 2023-05-01
- 1.10.0 — 2024-07-25
- 1.9.1 — 2024-07-23
- 1.9.0 — 2024-03-21
- 1.8.1 — 2024-02-21
- 1.8.0 — 2024-02-12
- 1.7.2 — 2024-01-23
- 1.7.1 — 2024-01-17
- 1.7.0 — 2024-01-11
- 1.6.0 — 2023-10-13
- 1.5.3 — 2023-09-11
- 1.5.2 — 2023-08-31
- 1.5.1 — 2023-08-21
- 1.4.0 — 2023-08-14
- … 2 more at https://npm.io/package/@vonage/proactive-connect/versions

## README

# Vonage Proactive Connect SDK for Node.js

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/proactive-connect?label=%40vonage%2Fproactive-connect&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license]

> [!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](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup].

For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).

* [Installation](#installation)
* [Usage](#usage)
* [Promise](#promises)
* [Testing](#testing)
* [Supported APIs](#supported-apis)

## Installation

### With NPM

```bash
npm install @vonage/proactive-connect
```

### With Yarn

```bash
yarn add @vonage/proactive-connect
```

## Usage

Unlike the other SDK's this package is not include in the [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk)

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.

```js
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`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options)

## Promises

This SDK uses Promises to return data.

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

## Testing

Run:

```bash
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      | ✅          |


[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk
[license]: ../../LICENSE.txt

---
_Source: https://npm.io/package/@vonage/proactive-connect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._