Vonage Conversations SDK for Node.js

!GitHub Workflow Status (branch)  !Latest Release  

This is the Vonage Conversations SDK for Node.js for use with Vonage APIs. To use it you will need a Vonage account. Sign up [for free][signup] at vonage.com.

For full API documentation refer to the Vonage Conversations API specs.

If you are updating from V2 to V3, please check the migration guide found here

* Installation
* Usage
* Promises

Installation

We recommend using this SDK as part of the overall @vonage/server-sdk package. Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Conversations API.

$3

``bash
npm install @vonage/conversations
`

$3

`bash
yarn add @vonage/conversations
`

Usage

$3

If you are using this SDK as part of the Vonage Server SDK, you can access it as the conversations property off of the client that you instantiate.

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

const vonage = new Vonage(new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
applicationId: APP_ID,
privateKey: PRIVATE_KEY_PATH,
}), options);

vonage.conversations.getConversation(CONVERSATION_ID)
`

$3

The SDK can be used standalone from the main Vonage Server SDK for Node.js
if you only need to use the Conversations API. All you need to do
is require('@vonage/conversations'), and use the returned object to create your own
client.

`js
const { Auth } = require('@vonage/auth');
const { Conversations } = require('@vonage/conversations');

const conversationsClient = new Conversations(new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
applicationId: APP_ID,
privateKey: PRIVATE_KEY_PATH,
}), options);

conversationsClient.getConversation(CONVERSATION_ID)
`

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.

`js
const resp = await conversationsClient.getConversation(CONVERSATION_ID)

conversationsClient.getConversation(CONVERSATION_ID)
.then(resp => console.log(resp))
.catch(err => console.error(err));
`

Testing

Run:

`bash
npm run test
``

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

[license]: ../../LICENSE.txt