@vonage/network-sim-swap
v1.3.1
Published
A Network API client for checking if a SIM card was swapped recently for a phone number
Downloads
28
Maintainers
Keywords
Readme
Vonage SIM Swap SDK for Node.js
This is the Vonage SIM Swap 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
With NPM
npm install @vonage/network-sim-swap
With Yarn
yarn add @vonage/network-sim-swap
Usage
Unlike the other SDK's this package is not include in the Vonage Server SDK for Node.js
const { Auth } = require('@vonage/auth')
const { SIMSwap } = require('@vonage/network-sim-swap')
const credentials = new Auth({
applicationId: APP_ID,
privateKey: PRIAVTE_KEY,
})
const options = {}
const simSwapClient = new SIMSwap(credentials, options)
Where credentials
is any option from @vonage/auth
,
and options
is any option from @vonage/network-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 simSwapClient.listSIMSwap()
simSwapClient
.checkSwapSim()
.then((resp) => console.log(resp))
.catch((err) => console.error(err))
Testing
Run:
npm run test