Sinch Node.js SDK for Conversation

The Sinch Conversation Node.js SDK allows you to quickly interact with the Conversation 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 Conversation API are structured similarly to those that are sent and received using the Conversation API itself.

// Find your App ID at dashboard.sinch.com/convapi/apps
// Find your Project ID at dashboard.sinch.com/settings/project-management
// Get your Access Key and Access Secret at dashboard.sinch.com/settings/access-keys
const APP_ID = '';
const ACCESS_KEY = '';
const ACCESS_SECRET = '';
const PROJECT_ID = '';
const CHANNEL = '';
const IDENTITY = '';

import fetch from 'node-fetch';

async function run() {
  const resp = await fetch(
    'https://us.conversation.api.sinch.com/v1/projects/' + PROJECT_ID + '/messages:send',
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        Authorization: 'Basic ' + Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64')
      },
      body: JSON.stringify({
        app_id: APP_ID,
        recipient: {
          identified_by: {
            channel_identities: [
              {
                channel: CHANNEL,
                identity: IDENTITY
              }
            ]
          }
        },
        message: {
          text_message: {
            text: 'Text message from Sinch Conversation API.'
          }
        }
      })
    }
  );

  const data = await resp.json();
  console.log(data);
}

run();

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

• Client initialization
• Conversation 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

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

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

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

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

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

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

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"
});

Conversation domain

Endpoint categories

In the Sinch Node.js SDK, Conversation API endpoints are accessible through the client (either a general client or a Conversation-specific client). The naming convention of the endpoint's representation in the SDK matches the API:

• messages
• app
• contact
• events
• transcoding
• capability
• templatesV1
• templatesV2
• webhooks
• conversation

For example:

const response = await sinchClient.conversation.messages.send({
    sendMessageRequestBody: {
        app_id: "YOUR_app_ID",
        recipient: {
            identified_by: {
                channel_identities: [
                    {
                        channel: "SMS",
                        identity: "RECIPIENT_number"
                    }
                ]
            }
        },
        message: {
            text_message: {
                text: "This is a test message using the Sinch Node.js SDK"
            }
        },
        channel_properties: {
            SMS_SENDER: "YOUR_sms_sender"
        }
    }
});

messages endpoint category

app endpoint category

contact endpoint category

conversation endpoint category

events endpoint category

transcoding endpoint category

capability endpoint category

webhooks endpoint category

templatesV1 endpoint category

templatesV2 endpoint category

Request and query parameters

Requests and queries made using the Node.js SDK are similar to those made using the Conversation API. Many of the fields are named and structured similarly. 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.

app_id: "{APP_ID}"

"app_id": "{APP_ID}"

const response = await sinchClient.conversation.messages.get({
                    message_id:"YOUR_message_id"
                    messages_source:"CONVERSATION_SOURCE"
                    });

url = "https://us.conversation.api.sinch.com/v1/projects/" + project_id + "/messages/" + YOUR_message_id

payload = {
    "messages_source": "CONVERSATION_SOURCE"
}

Responses

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

Pagination objects

• PageResult
• AsyncIteratorIterable

PageResult

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

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

// 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;
    }
  }

// 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;
    }
  }

AsyncIteratorIterable

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
  }

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.