Vonage Number Insights SDK for Node.js
![License](https://img.shields.io/npm/l/@vonage/number-insights?label=License&style=flat-square)
This is the Vonage Number Insights 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.
We recommend using this package as part of the overall
@vonage/server-sdk
package.
For full API documentation refer to developer.nexmo.com.
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
Messages API.
With NPM
npm install @vonage/number-insights
With Yarn
yarn add @vonage/number-insights
Using the Vonage Number Insights SDK
As part of the Vonage Server SDK
If you are using this SDK as part of the Vonage Server SDK, you can access it
as the messages
property off of the client that you instantiate.
const { Auth } = require('@vonage/auth);
const { Vonage } = require('@vonage/server-sdk');
const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};
const vonage = new Vonage(credentials, options);
vonage.numberInsights.basicLookup(PHONE_NUMBER)
.then(resp => console.log(resp))
.catch(err => console.error(err));
Standalone
The SDK can be used standalone from the main
Vonage Server SDK for Node.js if
you only need to use the Messages API. All you need to do is
require('@vonage/messages')
, and use the returned object to create your own
client.
const { Auth } = require('@vonage/auth');
const { NumberInsights } = require('@vonage/number-insights');
const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};
const niClient = new NumberInsights(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.numberInsights.basicLookup(PHONE_NUMBER)
vonage.numberInsights.basicLookup(PHONE_NUMBER)
.then(resp => console.log(resp))
.catch(err => console.error(err));
Testing
Run:
npm run test