Look up a number with Node.js

You can quickly see how the Number Lookup API works by looking up a number using the API.

In this guide you will learn how to:

Learn how to:

Set up your Node.js application
Look up your phone number

What you need to know before you start

Before you can get started, you need the following already set up:

Set all Number Lookup API configuration settings.
Node.js and a familiarity with how to create a new app.

Set up your Node.js application

To quickly get started setting up a simple client application using the Node SDK:

If you haven't already, clone the sinch-sdk-node repository.
Navigate to the examples/snippets/ folder.
Open a command prompt or terminal and run the following command to install the necessary dependencies:
```
npm install
```

Rename the .env.example file to .env. Using the access key credentials from your Sinch Build Dashboard, populate the following fields with your values:

Field	Description
SINCH_PROJECT_ID	The unique ID of your Project.
SINCH_KEY_ID	The unique ID of your access key.
SINCH_KEY_SECRET	The secret that goes with your access key. Note: For security reasons, this secret is only visible right after access key creation.

Note:

This tutorial uses basic authentication for testing purposes. We recommend using OAuth for authentication in a production environment. You can follow the steps in this guide, but use the code samples from here to use OAuth authentication instead.

Save the file.
Navigate to examples/snippets/number-lookup/lookup.js.

numbersSample.js

// Use this code to look up a number. 
/**
 * Class to lookup a number through the NumberLookup API using the Sinch Node.js SDK.
 */
export class NumberLookupSample {
  /**
   * @param { import('@sinch/sdk-core').NumberLookupService } numberLookupService - the NumberLookupService instance from the Sinch SDK containing the API methods.
   */
  constructor(numberLookupService) {
    this.numberLookupService = numberLookupService;
  }

  async start() {
    // The phone number to lookup in E.164 format
    const phoneNumber = 'PHONE_NUMBER_TO_LOOKUP';

    const response = await this.numberLookupService.lookup({
      numberLookupRequestBody: {
        number: phoneNumber,
      },
    });

    console.log('Response:', response);
  }
}

Assign your values to the following parameters:
Parameter Your value
NUMBER The phone number that you want to look up in E.164 format.
Save the file.

Parameter	Your value
`NUMBER`	The phone number that you want to look up in E.164 format.

Look up your phone number

Now you can execute the code and look up your phone number. Open a terminal or command prompt to the examples/snippets/ folder and run the following command:

npm run number-lookup:lookup

You should receive a response in your console with details about the phone number you specified.

Troubleshooting tip

If after running your app you receive a 5000 error response, you may have forgotten to save your file after adding your authentication values. This is an easy mistake to make! Try saving the file and running the app again.

Additional resources

API specification