Sinch Numbers SDK for Node.js

This package contains the Sinch Numbers SDK for Node.js for use with Sinch APIs. To use it, you will need a Sinch account. Please sign up or log in if you already have one.

Installation

We recommend to use this SDK as part of the @sinch/sdk-core package in order to make the most out of all the Sinch products.

However, it's still possible to use this SDK standalone is you need to access the Numbers API only.

With NPM

npm install @sinch/numbers

With Yarn

yarn add @sinch/numbers

Usage

Credentials

The Numbers API uses the Sinch unified authentication with OAuth2. You will need to provide the following credentials:

• projectId: can be found in the Account Dashboard
• keyId:: can be found in your Access key list in the Account Dashboard
• keySecret: can be found ONLY when generating a new access key: keep it safe!

As part of the Sinch SDK

If you are using this SDK as part of the Sinch SDK (@sinch/sdk-core) you can access it as the numbers property of the client that you would have instantiated.

import { 
  Numbers,
  NumbersService,
  SinchClient,
  UnifiedCredentials,
} from '@sinch/sdk-core';

const credentials: UnifiedCredentials = {
  projectId: 'PROJECT_ID',
  keyId: 'KEY_ID',
  keySecret: 'KEY_SECRET',
};

// Access the 'numbers' service registered on the Sinch Client
const sinch = new SinchClient(credentials);
const numbersService: NumbersService = sinch.numbers;

// Build the request data
const requestData: Numbers.GetAvailableNumberRequestData = {
  phoneNumber: '+17813334444',
};

// Use the 'numbers' service registered on the Sinch client
const availabilityResult: Numbers.AvailableNumber 
    = await numbersService.availableNumber.checkAvailability(requestData);

Standalone

The SDK can be used standalone if you need to use only the Numbers APIs.

import {
  UnifiedCredentials,
} from '@sinch/sdk-client';
import {
  Numbers,
  NumbersService,
} from '@sinch/numbers';

const credentials: UnifiedCredentials = {
  projectId: 'PROJECT_ID',
  keyId: 'KEY_ID',
  keySecret: 'KEY_SECRET',
};

// Declare the 'numbers' service in a standalone way
const numbersService = new NumbersService(credentials);

// Build the request data
const requestData: Numbers.GetAvailableNumberRequestData = {
  phoneNumber: '+17813334444',
};

// Use the standalone declaration of the 'numbers' service
const availabilityResult: Numbers.AvailableNumber 
    = await numbersService.availableNumber.checkAvailability(requestData);

Promises

All the methods that interact with the Sinch APIs use Promises. You can use await in an async method to wait for the response, or you can resolve them yourself with then() / catch().

// Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
let availabilityResult: Numbers.AvailableNumber;
try {
  availabilityResult = await numbersService.availableNumber.checkAvailability(requestData);
  console.log(`Phone number: ${availabilityResult.phoneNumber} - Type: ${availabilityResult.type}`);
} catch (error: any) {
  console.error(`ERROR ${error.statusCode}: the phone number ${requestData.phoneNumber} is not available`);
}

// Method 2: Resolve the promise
numbersService.availableNumber.checkAvailability(requestData)
  .then(response => console.log(`Phone number: ${response.phoneNumber} - Type: ${response.type}`))
  .catch(error => console.error(`ERROR ${error.statusCode}: the phone number ${requestData.phoneNumber} is not available`));

Contact

Developer Experience team: [email protected]