{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/voice-2.0/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"product":"Voice v2 (preview)","type":"markdown"},"seo":{"title":"Node.js SDK Reference | Voice API v2 | Sinch","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API (legacy/GA)","description":"Which Voice API? If you are building something using voice AI agents, use the Voice API v2. To learn more, you can read [Why migrate to v2?](/docs/voice-2.0/migration.md) or [What's new?](/docs/voice-2.0/whatsnew.md).\n\nThe Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md"],"excludeFiles":["docs/voice/index.md"]},{"title":"Voice API v2 (recommended for new builds/preview)","description":"Which Voice API? If you are building something using voice AI agents, use the Voice API v2. To learn more, you can read [Why migrate to v2?](/docs/voice-2.0/migration.md) or [What's new?](/docs/voice-2.0/whatsnew.md).\n\nThe Voice API v2 enables embedding voice calling into applications for virtually limitless use cases. From voice-enabling AI agents to allow real-time conversational AI workflows over the phone, to number masking for privacy, automated appointment reminders, and outreach campaigns with answering machine detection, to bridging calls between PSTN and SIP endpoints, the API offers the flexibility and control needed for modern communications. The Sinch Programmable Voice is a cloud-native global voice platform, composed by multiple Inbound and Outbound voice channels. All these channels can be combined using our powerful markup language called SVAML v2, creating a toolbox capable of building almost limitless use cases. Our SVAML uses the concept of commands, and customers can use a combination of our commands to interact with calls in all channels, in order to model from the most basic to highly complex scenarios, required to fulfill their voice calling needs.","includeFiles":["docs/voice-2.0/**/*.md"],"excludeFiles":["docs/voice-2.0/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/ai-support.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for Sinch numbers, messaging, voice, fax, SIP trunking and porting, and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]},"description":"Learn the syntax of the Sinch Node.js SDK for Voice API v2."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sinch-nodejs-sdk-for-voice-api-v2","__idx":0},"children":["Sinch Node.js SDK for Voice API v2"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Sinch Node.js SDK allows you to quickly interact with the ","Voice API v2"," from inside your Node.js applications. When using the Node.js SDK, the code representing requests and queries sent to and responses received from the ","Voice API v2"," are structured similarly to those that are sent and received using the ","Voice API v2","."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The fastest way to get started with the SDK is to check out our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/voice-2.0/getting-started"},"children":["getting-started"]}," guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"syntax","__idx":1},"children":["Syntax"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide describes the syntactical structure of the Node.js SDK for the Voice API v2, including any differences that may exist between the API itself and the SDK. For a full reference on Voice API v2 calls and responses, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/voice-2.0/api-reference/voice"},"children":["Voice API v2 Reference"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The code sample below is an example of how to use the Node.js SDK to make a Text to speech phone call. We've also provided an example that accomplishes the same task using the REST API."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"SDK","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/code-snippets/node-sdk/voice-v2/make-call.sample.js","language":"javascript","title":"start.js","header":{"title":"start.js","controls":{"copy":{}}},"lang":"javascript","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient, Voice } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number to be used as the caller ID, in E.164 format (e.g., +12025550123)\n  const sinchPhoneNumber = process.env.SINCH_PHONE_NUMBER || 'MY_SINCH_PHONE_NUMBER';\n  // The phone number you want to call, in E.164 format (e.g., +12025550123)\n  const recipientPhoneNumber = 'RECIPIENT_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try {\n    const response = await sinch.voice.v2.calls.start({\n      createCallRequestBody: {\n        commands: new Voice.v2.CommandsSequenceCreator()\n          .dial((dialCreator) => {\n            dialCreator\n              .name('Node_SDK_Snippet_Call')\n              .from(Voice.v2.Destination.of(sinchPhoneNumber))\n              .to(Voice.v2.Destination.of(recipientPhoneNumber))\n              .onAnswer((sequence) => {\n                sequence.text('Hello, your call is now connected.', 'Emma', {\n                  onFinish: Voice.v2.Calls.hangup(),\n                });\n              });\n          })\n          .build(),\n      },\n    });\n    console.log(`✅ Successfully started a Voice v2 call to ${recipientPhoneNumber}.`);\n    console.log(`Response:\\n${JSON.stringify(response, null, 2)}`);\n  } catch (err) {\n    console.error(`❌ Failed to start a Voice v2 call to ${recipientPhoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"REST API","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const query = new URLSearchParams({\n  serviceId: '6e124178-c29d-46a5-943c-5c2ae544aade'\n}).toString();\n\nconst projectId = 'YOUR_projectId_PARAMETER';\nconst resp = await fetch(\n  `https://voice.api.sinch.com/v2/projects/${projectId}/calls?${query}`,\n  {\n    method: 'POST',\n    headers: {\n      'Content-Type': 'application/json',\n      'Idempotency-Key': 'stringstringstri',\n      Authorization: 'Basic ' + btoa('<username>:<password>')\n    },\n    body: JSON.stringify({\n      commands: [\n        {\n          command: 'dial',\n          callName: 'origin',\n          from: {\n            type: 'PHONE',\n            phone: {number: '+15551234567'}\n          },\n          to: {\n            type: 'PHONE',\n            phone: {number: '+15559876543'}\n          },\n          dialTimeoutDurationSeconds: 30,\n          maxCallDurationSeconds: 3600,\n          events: {\n            onAnswer: [\n              {\n                command: 'messages',\n                messages: [\n                  {\n                    type: 'SAY',\n                    say: {\n                      text: 'Hello, your call is now connected.',\n                      voiceName: 'Emma'\n                    }\n                  }\n                ]\n              }\n            ],\n            onHangup: [{command: 'hangup'}]\n          }\n        }\n      ]\n    })\n  }\n);\n\nconst data = await resp.json();\nconsole.log(data);\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example highlights the following required to successfully make a Voice API call using the Sinch Node.js SDK:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#client"},"children":["Client initialization"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#voice-v2-domain"},"children":["Voice domain access"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#endpoint-categories"},"children":["Endpoint usage"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#request-and-query-parameters"},"children":["Field population"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"client","__idx":2},"children":["Client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"initialization","__idx":3},"children":["Initialization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To start using the SDK, you need to initialize the main client class with your credentials from your Sinch ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/dashboard"},"children":["dashboard"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const {SinchClient} = require('@sinch/sdk-core');\n\nconst sinchClient = new SinchClient({\n    projectId: \"YOUR_project_id\",\n    keyId: \"YOUR_access_key\",\n    keySecret: \"YOUR_access_secret\"\n});\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".env"]}," File"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"PROJECTID=\"YOUR_project_id\"\nACCESSKEY=\"YOUR_access_key\"\nACCESSSECRET=\"YOUR_access_secret\" \n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["app.js"]}," File"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const {SinchClient} = require('@sinch/sdk-core');\n\nconst sinchClient = new SinchClient({\n    projectId: process.env.PROJECTID,\n    keyId: process.env.ACCESSKEY,\n    keySecret: process.env.ACCESSSECRET\n});\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"voice-v2-domain","__idx":4},"children":["Voice v2 domain"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Sinch Node.js SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch.voice.v2.[endpoint_category].[method()]"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoint-categories","__idx":5},"children":["Endpoint categories"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Sinch Node.js SDK, Voice API endpoints are accessible through the client. The naming convention of the endpoint's representation in the SDK matches the API:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.sinch.com/sdk/sinch-sdk-node/1.8.0/classes/VoiceV2BatchesApi.html"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.batches"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/external-blue.5a59beb5e5a442f78b530509ddf6b5d0fa705285ff8181e59adf96b5c2c73e25.33310b29.svg","alt":"external"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.sinch.com/sdk/sinch-sdk-node/1.8.0/classes/VoiceV2CallsApi.html"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.calls"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/external-blue.5a59beb5e5a442f78b530509ddf6b5d0fa705285ff8181e59adf96b5c2c73e25.33310b29.svg","alt":"external"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.sinch.com/sdk/sinch-sdk-node/1.8.0/classes/VoiceV2ServicesApi.html"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.services"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/external-blue.5a59beb5e5a442f78b530509ddf6b5d0fa705285ff8181e59adf96b5c2c73e25.33310b29.svg","alt":"external"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.sinch.com/sdk/sinch-sdk-node/1.8.0/classes/VoiceV2SessionsApi.html"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.sessions"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/external-blue.5a59beb5e5a442f78b530509ddf6b5d0fa705285ff8181e59adf96b5c2c73e25.33310b29.svg","alt":"external"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developers.sinch.com/sdk/sinch-sdk-node/1.8.0/classes/VoiceV2SvamlApi.html"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.svaml"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/external-blue.5a59beb5e5a442f78b530509ddf6b5d0fa705285ff8181e59adf96b5c2c73e25.33310b29.svg","alt":"external"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const response = await sinch.voice.v2.calls.start({\n      createCallRequestBody: {\n        commands: new Voice.v2.CommandsSequenceCreator()\n          .dial((dialCreator) => {\n            dialCreator\n              .name('Node_SDK_Snippet_Call')\n              .from(Voice.v2.Destination.of(sinchPhoneNumber))\n              .to(Voice.v2.Destination.of(recipientPhoneNumber))\n              .onAnswer((sequence) => {\n                sequence.text('Hello, your call is now connected.', 'Emma', {\n                  onFinish: Voice.v2.Calls.hangup(),\n                });\n              });\n          })\n          .build()}})\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-and-query-parameters","__idx":6},"children":["Request and query parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests and queries made using the Node.js SDK are similar to those made using the Voice API. 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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, consider this example in which the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get()"]}," method of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice.v2.calls"]}," class is invoked:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const response = await sinch.voice.v2.calls.get({\n      callId,\n    });\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"\nurl = \"https://voice.api.sinch.com/v2/projects/${projectId}/calls/${callId}\"\n\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using the Voice API, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callId"]}," would be included as a path parameter in the request. With the Node.js SDK, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callId"]}," parameter is used in an object passed as an argument in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get()"]}," method."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"responses","__idx":7},"children":["Responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response fields match the API responses. They are delivered as Javascript objects."]}]},"headings":[{"value":"Sinch Node.js SDK for Voice API v2","id":"sinch-nodejs-sdk-for-voice-api-v2","depth":1},{"value":"Syntax","id":"syntax","depth":2},{"value":"Client","id":"client","depth":2},{"value":"Initialization","id":"initialization","depth":3},{"value":"Voice v2 domain","id":"voice-v2-domain","depth":2},{"value":"Endpoint categories","id":"endpoint-categories","depth":2},{"value":"Request and query parameters","id":"request-and-query-parameters","depth":2},{"value":"Responses","id":"responses","depth":2}],"frontmatter":{"seo":{"title":"Node.js SDK Reference | Voice API v2 | Sinch","description":"Learn the syntax of the Sinch Node.js SDK for Voice API v2."},"product":"Voice API v2"},"lastModified":"2026-09-25T16:09:51.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/voice-2.0/sdk/node/syntax-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}