integrated-flows-examples

Integrated flows with the Sinch Node.js SDK

This directory contains some code samples to illustrate how to chain services supported in the Sinch Node.js SDK.

Prerequisites

Before trying to run a sample, make sure you have Node.js installed: please download and install the LTS version from nodejs.org.

Once installed, check you can run node with the following command:

node --version

You should see a result such as v20.10.0, matching the LTS you have downloaded or the version you had previously installed.

To use the Sinch Node.js SDK packages, you will need a package manager such as NPM (already installed with Node.js) or yarn.

To install yarn (optional), run the following command:

npm install --global yarn

Configuration

To be able to send requests to the Sinch APIs, you need to have a Sinch account. Please sign up or log in if you already have one.

With the credentials found on the Sinch dashboards, you will have to fill the file .env.template and rename it to .env. This file needs to be located at the same place where you will be executing the sample applications.

# Credentials for APIs using OAuth2 authentication
SINCH_PROJECT_ID=project-id found at https://dashboard.sinch.com/account/access-keys
SINCH_KEY_ID=access-key-id found at https://dashboard.sinch.com/account/access-keys
SINCH_KEY_SECRET=access-key-secret found at access-key creation time

# Application credentials for Verification and Voice APIs
SINCH_APPLICATION_KEY=application-key found at https://dashboard.sinch.com/verification/apps
SINCH_APPLICATION_SECRET=application-secret found at https://dashboard.sinch.com/verification/apps

Note: If you prefer using environment variables, the sample app is also supporting them: they take precedence over the value from the .env file.

Available flows

Numbers

This app will try to rent a number or type LOCAL and manage it. the following requests will be chained:

• the first request will return all the regions where we can rent a number of type LOCAL. We will store one of the values from the response.
• Now that we have a region, we list all the numbers of type LOCAL available for rental in this region.
• From the list of available numbers in the response, we select one, and we send another request to rent it
• Alternative: renting a number can be done in only one step with the rentAny method. The application will rent a second number with this method.
• Once a number is rented, it becomes an "active" number.
  • A possibility to check is a number belongs to us, is to request it in the "active" domain
  • Another possibility is to list our active numbers and check if the numbers we have rented are part of the list. This example illustrates the pagination.
• The next request will update some properties of our numbers
• Finally, we will release our numbers to not be charged for more than 1 month.

Run the flow:

# With NPM
npm run numbers:app
# With Yarn
yarn run numbers:app

Verification

This app will perform a phone number verification in an interactive flow:

• the user chooses which verification method to use: SMS, Callout, Flash call or Seamless
• the user inputs the phone number to verify
• an API call is made to start the verification flow according to the chosen method
• except for a seamless verification, the user is asked to input:
  • the OTP received by SMS for an SMS verification
  • the OTP received by dictation for a Callout verification
  • the Caller ID displayed on the phone for a Flash Call verification
• once the code is submitted, another API call is made to report the verification and the returned status is displayed

Run the flow:

# With NPM
npm run verification:app
# With Yarn
yarn run verification:app