Sinch Node.js SDK for SMS

The Sinch SMS Node.js SDK allows you to quickly interact with the SMS API from inside your Node.js applications. The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

Syntax

When using the Node.js SDK, the code representing requests and queries sent to and responses received from the SMS API are structured similarly to those that are sent and received using the SMS API itself.

Note:

This guide describes the syntactical structure of the Node.js SDK for the SMS API, including any differences that may exist between the API itself and the SDK. For a full reference on SMS API calls and responses, see the SMS REST API Reference.

The code sample on the side of this page is an example of how to use the Node.js SDK to send an SMS message. The code is also displayed below, along with an SMS API call that accomplishes the same task, for reference:

REST APISDKSDK using import statements

Copy

Copied

const SERVICE_PLAN_ID = 'YOUR_servicePlanId';
const API_TOKEN = 'YOUR_API_token';
const SINCH_NUMBER = 'YOUR_Sinch_virtual_number';
const TO_NUMBER = 'RECIPIENT_number';
const REGION ='YOUR_region'
const SINCH_URL= 'https://'+REGION+'.sms.api.sinch.com/xms/v1/' + SERVICE_PLAN_ID + '/batches'

const axios = require('axios')


const headers={'Content-Type': 'application/json', 'Authorization': 'Bearer ' + API_TOKEN}
const payload = JSON.stringify({
    from: SINCH_NUMBER,
    to: [TO_NUMBER],
    body: 'Programmers are tools for converting caffeine into code. We just got a new shipment of mugs! Check them out: https://tinyurl.com/4a6fxce7!'
  })
axios.post(SINCH_URL, payload, { headers })
    .then(response =>
        console.log(response.data)
    ).catch(error =>
    console.error('There was an error!', error.response)
);

Copy

Copied

const { SinchClient } = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    projectId: "YOUR_project_id",
    keyId: "YOUR_access_key",
    keySecret: "YOUR_access_secret"
});

async function run(){
  const response = await sinchClient.sms.batches.send({
      sendSMSRequestBody: {
          to: [
              "YOUR_to_number"
          ],
          from: "YOUR_sinch_number",
          body: "This is a test message using the Sinch Javascript SDK."
      }
  });

  console.log(JSON.stringify(response));
}

run();

Copy

Copied

// import statements can only be used in javascript modules.
// This inclides frameworks like React or Angular or .mjs files
import { SinchClient } from '@sinch/sdk-core';

const sinchClient = new SinchClient({
    projectId: "YOUR_project_id",
    keyId: "YOUR_access_key",
    keySecret: "YOUR_access_secret"
});

async function run(){
  const response = await sinchClient.sms.batches.send({
      sendSMSRequestBody: {
          to: [
              "YOUR_to_number"
          ],
          from: "YOUR_sinch_number",
          body: "This is a test message using the Sinch Javascript SDK."
      }
  });

  console.log(JSON.stringify(response));
}

run();

This example highlights the following required to successfully make an SMS API call using the Sinch Node.js SDK:

Client initialization
SMS domain access
Endpoint usage
Field population

Client

When using the Sinch Node.js SDK, you initialize communication with the Sinch backend by initializing the Node.js SDK's main client class. This client allows you to access the functionality of the Sinch Node.js SDK.

Initialization

Before initializing a client using this SDK, you'll need three pieces of information:

Your Project ID
An access key ID
An access key Secret

These values can be found on the Access Keys page of the Customer Dashboard. You can also create new access key IDs and Secrets, if required.

Note:

If you have trouble accessing the above link, ensure that you have gained access to the Conversation API by accepting the corresponding terms and conditions.

To start using the SDK, you need to initialize the main client class with your credentials from your Sinch dashboard.

Copy

Copied

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    projectId: "YOUR_project_id",
    keyId: "YOUR_access_key",
    keySecret: "YOUR_access_secret"
});

Note:

For testing purposes on your local environment it's fine to use hardcoded values, but before deploying to production we strongly recommend using environment variables to store the credentials, as in the following example:

.env File

Copy

Copied

PROJECTID="YOUR_project_id"
ACCESSKEY="YOUR_access_key"
ACCESSSECRET="YOUR_access_secret"

app.js File

Copy

Copied

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    projectId: process.env.PROJECTID,
    keyId: process.env.ACCESSKEY,
    keySecret: process.env.ACCESSSECRET
});

Note:

If you are using the Node.js SDK for multiple products that use different sets of authentication credentials, you can include all of the relevant credentials in the same configuration object, as in the following example:

Copy

Copied

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    projectId: "YOUR_project_id",
    keyId: "YOUR_access_key",
    keySecret: "YOUR_access_secret",
    applicationKey: "YOUR_application_key",
    applicationSecret: "YOUR_application_secret"
});

sms domain

The Sinch Node.js SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, sinch.sms.[endpoint_category].[method()].

Endpoint categories

In the Sinch Node.js SDK, SMS API endpoints are accessible through the client. The naming convention of the endpoint's representation in the SDK matches the API:

sms.batches
sms.deliveryReports
sms.groups
sms.inbounds

For example:

Copy

Copied

const response = await sinchClient.sms.batches.send({
    sendSMSRequestBody: {
        to: [
            "+13215013855"
        ],
        from: "+12074193397",
        body: "This is a test message from the Node.js SDK."
    }
});

`sms.batches` endpoint category

The sms.batches category of the Node.js SDK corresponds to the batches endpoint. The mapping between the API operations and corresponding Node.js methods are described below:

API operation	SDK method
Send	`send()`
List batches	`list()`
Dry run	`dryRun()`
Get a batch message	`get()`
Update a batch message	`update()`
Replace a batch	`replace()`
Cancel a batch message	`cancel()`
Send delivery feedback for a message	`sendDeliveryFeedback()`

`sms.deliveryReports` endpoint category

The sms.deliveryReports category of the Node.js SDK corresponds to the delivery_report and delivery_reports endpoints. The mapping between the API operations and corresponding Node.js methods are described below:

API operation	SDK method
Retrieve a delivery report	`get()`
Retrieve a recipient delivery report	`getByPhoneNumber()`
Retrieve a list of delivery reports	`list()`

`sms.groups` endpoint category

The sms.groups category of the Node.js SDK corresponds to the groups endpoint. The mapping between the API operations and corresponding Node.js methods are described below:

API operation	SDK method
List groups	`list()`
Create a group	`create()`
Retrieve a group	`get()`
Update a group	`update()`
Replace a group	`replace()`
Delete a group	`delete()`
List group member phone numbers	`listMembers()`

`sms.inbounds` endpoint category

The sms.inbounds category of the Node.js SDK corresponds to the inbounds endpoint. The mapping between the API operations and corresponding Node.js methods are described below:

API operation	SDK method
List incoming messages	`list()`
Retrieve inbound message	`get()`

Request and query parameters

Requests and queries made using the Node.js SDK are similar to those made using the SMS API. Additionally, path parameters, request body parameters, and query parameters that are used in the API are all passed as arguments to the corresponding Node.js method.

For example, consider this example in which the get() method of the sms.batches class is invoked:

SDKREST API

Copy

Copied

const smsResponse = sinchClient.sms.batches.get({
  batch_id: "BATCH_ID"
  });

Copy

Copied

url = "https://us.SMS.api.sinch.com/v1/" + service_plan_id + "/batches/" + batch_id

When using the SMS API, service_plan_id and batch_id would be included as path parameters in the JSON payload. With the Node.js SDK, the batch_id parameter is included as an argument in the get() method.

Note:

Note that the service_plan_id path parameter does not need to be included in any requests created by the Node.js SDK.

Responses

Response fields match the API responses. They are delivered as Javascript objects.

Pagination objects

For operations that return multiple pages of objects, such as list operations, the API response that would normally be an array is instead wrapped inside an ApiPromiseList object. This object can take two forms, depending on how you have made the call:

`PageResult`

If you are using a traditional await in front of the method, the ApiPromiseList will take the form of a PageResult, as demonstrated by the following example:

NumbersConversation

Copy

Copied

const requestData: ListActiveNumbersRequestData = {
    regionCode: 'US',
    type: 'LOCAL',
    pageSize: 2,
  };

  // This call will return the data of the current page wrapped in a PageResult
  // We can then loop on the response while it has more pages
  let response: PageResult<ActiveNumber> = await sinchClient.numbers.activeNumber.list(requestData); 

  // The ActiveNumber are in the `data` property
  let activeNumbers: ActiveNumber[] = response.data;
  console.log(activeNumbers); // prints the content of a page

Copy

Copied

const requestData: ListMessagesRequestData = {
    app_id: "YOUR_Conversation_app_ID,
    channel: 'MESSENGER',
  };

  // This call will return the data of the current page wrapped in a PageResult
  // We can then loop on the response while it has more pages
  let response: PageResult<ConversationMessage> = await sinchClient.conversation.messages.list(requestData);

  // The ConversationMessage are in the `data` property
  let messages: ConversationMessage[] = response.data;
  console.log(messages); // prints the content of a page

The array is contained in the data field and the object contains a hasNextPage boolean as well as a nextPage() function which can be used to iterate through the results.

NumbersConversation

Copy

Copied

// Loop on all the pages to get all the active numbers
  let reachedEndOfPages = false;
  while (!reachedEndOfPages) {
    if (response.hasNextPage) {
      response = await response.nextPage();
      activeNumbers = response.data;
      console.log(activeNumbers); // prints the content of a page
    } else {
      reachedEndOfPages = true;
    }
  }

Copy

Copied

// Loop on all the pages to get all the messages
  let reachedEndOfPages = false;
  while (!reachedEndOfPages) {
    if (response.hasNextPage) {
      response = await response.nextPage();
      messages = response.data;
      console.log(messages); // prints the content of a page
    } else {
      reachedEndOfPages = true;
    }
  }

Each call to the Sinch servers is visible in the code in the while loop.

`AsyncIteratorIterable`

If you using an iterator (for await (... of ...)), the ApiPromiseList will take the form of a AsyncIteratorIterable object which can be used to iterate through the results, as demonstrated by the following example:

NumbersConversation

Copy

Copied

const requestData: ListActiveNumbersRequestData = {
    regionCode: 'US',
    type: 'LOCAL',
    pageSize: 2,
  };

  for await (const activeNumber of sinchClient.numbers.activeNumber.list(requestData)) {
    console.log(activeNumber); // prints a single ActiveNumber
  }

Copy

Copied

const requestData: ListMessagesRequestData = {
    app_id: "YOUR_Conversation_app_ID,
    channel: 'MESSENGER',
  };

  for await (const message of sinchClient.conversation.messages.list(requestData)) {
    console.log(message); // prints a single ConversationMessage
  }

With the iterator, the code is more concise but you have less control over the number of calls made to the API; the iterator will continue to make calls to the API to fetch the next page until the final page is returned.

Sinch Node.js SDK for SMS

Syntax

Note:

Client

Initialization

Note:

Note:

Note:

sms domain

Endpoint categories

sms.batches endpoint category

sms.deliveryReports endpoint category

sms.groups endpoint category

sms.inbounds endpoint category

Request and query parameters

Note:

Responses

Pagination objects

PageResult

AsyncIteratorIterable

`sms.batches` endpoint category

`sms.deliveryReports` endpoint category

`sms.groups` endpoint category

`sms.inbounds` endpoint category

`PageResult`

`AsyncIteratorIterable`