Vonage Number SDK for Node.js

!GitHub Workflow Status  !Latest Release  ![License][license]

This is the Vonage Number 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][signup].

For full API documentation refer to developer.nexmo.com.

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

* Installation
* Usage
* Promises
* Testing

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 Numbers API.

$3

``bash
npm install @vonage/numbers
`

$3

`bash
yarn add @vonage/numbers
`

Usage

$3

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

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

const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};
const vonage = new Vonage(credentials, options);

vonage.numbers.getAvailableNumbers()
.then(resp => console.log(resp))
.catch(err => console.error(err));
`

$3

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

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

const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};

const numbersClient = new Numbers(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.

`js
const resp = await vonage.numbers.basicLookup(PHONE_NUMBER)

vonage.numbers.getAvailableNumbers()
.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