sinch/sinch-voice-api

Sinch Voice API

Overview

The Sinch Voice API lets you make, receive, and control voice calls programmatically via REST. It uses SVAML (Sinch Voice Application Markup Language) to define call flows through callback events.

Agent Instructions

Before generating code, gather from the user (skip any item already specified in the prompt or context):

1. Approach — SDK or direct API calls (curl/fetch/requests)?
2. Language — for SDK: Node.js, Python, Java, or .NET. For direct API: any language, or curl.

When the user chooses SDK, refer to the sinch-sdks skill for installation and client initialization, then to the bundled examples and SDK reference linked in Links.

When the user chooses direct API calls, refer to the Voice API Reference linked in Links for request/response schemas.

Security: See the Security section below for url fetching policy, handling inbound callback content, and credential handling.

Getting Started

Agent Credentials handling

Store credentials in environment variables — never hardcode application keys or secrets in commands or source code:

export SINCH_APPLICATION_KEY="your-application-key"
export SINCH_APPLICATION_SECRET="your-application-secret"

Authentication

Ensure that authentication headers are properly set when making API calls. The Voice API uses Application Key + Application Secret (not project-level OAuth2):

-u "$SINCH_APPLICATION_KEY:$SINCH_APPLICATION_SECRET"

See the sinch-authentication skill for full setup.

• Basic Auth: Authorization: Basic base64(APPLICATION_KEY:APPLICATION_SECRET)
• Signed Requests (production): HMAC-SHA256 signing. See Authentication Guide.

Base URLs

| Region | Base URL | |--------|----------| | Global (default) | https://calling.api.sinch.com | | North America | https://calling-use1.api.sinch.com | | Europe | https://calling-euc1.api.sinch.com | | Southeast Asia 1 | https://calling-apse1.api.sinch.com | | Southeast Asia 2 | https://calling-apse2.api.sinch.com | | South America | https://calling-sae1.api.sinch.com |

Configuration endpoints (numbers, callbacks) use: https://callingapi.sinch.com

SDK Installation

See sinch-sdks for installation and client initialization across all languages.

First API Call: TTS Callout

curl -X POST \
  "https://calling.api.sinch.com/calling/v1/callouts" \
  -u "$SINCH_APPLICATION_KEY:$SINCH_APPLICATION_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ttsCallout",
    "ttsCallout": {
      "destination": { "type": "number", "endpoint": "+14045005000" },
      "cli": "+14045001000",
      "locale": "en-US",
      "text": "Hello! This is a test call from Sinch."
    }
  }'

Node.js SDK:

import { SinchClient } from "@sinch/sdk-core";

const sinch = new SinchClient({
  applicationKey: "{APPLICATION_KEY}",
  applicationSecret: "{APPLICATION_SECRET}",
});

const response = await sinch.voice.callouts.tts({
  ttsCalloutRequestBody: {
    destination: { type: "number", endpoint: "+14045005000" },
    cli: "+14045001000",
    locale: "en-US",
    text: "Hello! This is a test call from Sinch.",
  },
});
console.log("Call ID:", response.callId);

For more examples, see Callouts Reference or bundled examples.

Key Concepts

SVAML (Sinch Voice Application Markup Language)

SVAML controls call flow. Every SVAML response has:

• instructions (array): Multiple tasks — play audio, record, set cookies
• action (object): Exactly ONE routing/control action

Full reference: SVAML Actions | SVAML Instructions | Bundled SVAML Reference

Actions (one per response)

| Action | Description | |--------|-------------| | hangup | Terminate the call | | continue | Continue call setup (ACE response to proceed without rerouting) | | connectPstn | Connect to PSTN number. Supports amd for Answering Machine Detection | | connectMxp | Connect to Sinch SDK (in-app) endpoint | | connectConf | Connect to conference room by conferenceId | | connectSip | Connect to SIP endpoint | | connectStream | Connect to a WebSocket server for real-time audio streaming (closed beta — contact Sinch to enable) | | runMenu | IVR menu with DTMF collection (supports enableVoice for speech input) | | park | Park (hold) the call with looping prompt |

Instructions (multiple per response)

| Instruction | Description | |-------------|-------------| | playFiles | Play audio files, TTS via #tts[], SSML via #ssml[] | | say | Synthesize and play text-to-speech | | sendDtmf | Send DTMF tones | | setCookie | Persist key-value state across callback events in the session | | answer | Answer the call (sends a SIP 200 OK to the INVITE, which starts billing). Required before playing prompts on unanswered calls | | startRecording | Begin recording. Supports transcriptionOptions for auto-transcription | | stopRecording | Stop an active recording |

Callback Events

| Event | Trigger | SVAML Response | |-------|---------|----------------| | ICE | Call received by Sinch platform | Yes | | ACE | Call answered by callee | Yes | | DiCE | Call disconnected | No (fire-and-forget, logging only) | | PIE | DTMF/voice input from runMenu | Yes | | Notify | Notification (e.g., recording finished) | No |

See Callbacks Reference for event schemas, or bundled callbacks reference for full field tables and JSON examples.

Callout Types

| Method | Use Case | |--------|----------| | ttsCallout | Call and play synthesized speech. Supports text or advanced prompts (#tts[], #ssml[], #href[]) | | conferenceCallout | Call and connect to a conference room | | customCallout | Full SVAML control with inline ICE/ACE/PIE |

Callout flags: enableAce (default false), enableDice (default false), enablePie (default false) control which callbacks fire.

REST Endpoints

Paths starting with /calling/v1/ use the regional base URL from the table above. Paths starting with /v1/configuration/ use https://callingapi.sinch.com.

| Method | Endpoint | Description | |--------|----------|-------------| | POST | /calling/v1/callouts | Place a callout (TTS, conference, or custom) | | PATCH | /calling/v1/calls/id/{callId} | Update in-progress call with SVAML (PSTN/SIP only) | | GET | /calling/v1/calls/id/{callId} | Get call info | | PATCH | /calling/v1/calls/id/{callId}/leg/{callLeg} | Manage a call leg (PlayFiles/Say only) | | GET | /calling/v1/conferences/id/{conferenceId} | Get conference info | | DELETE | /calling/v1/conferences/id/{conferenceId} | Kick all participants | | PATCH | /calling/v1/conferences/id/{conferenceId}/{callId} | Mute/unmute/hold participant | | DELETE | /calling/v1/conferences/id/{conferenceId}/{callId} | Kick specific participant | | GET | /v1/configuration/numbers | List numbers and capabilities | | POST | /v1/configuration/numbers | Assign numbers to an application | | DELETE | /v1/configuration/numbers | Un-assign a number | | GET/POST | /v1/configuration/callbacks/applications/{applicationkey} | Get/update callback URLs |

Common Patterns

IVR Menu (SVAML)

{
  "instructions": [
    { "name": "setCookie", "key": "step", "value": "ivr" }
  ],
  "action": {
    "name": "runMenu",
    "mainMenu": "main",
    "menus": [{
      "id": "main",
      "mainPrompt": "#tts[Press 1 for sales or 2 for support.]",
      "options": [
        { "dtmf": 1, "action": "return(sales)" },
        { "dtmf": 2, "action": "return(support)" }
      ]
    }]
  }
}

Conference with Recording

{
  "instructions": [
    { "name": "startRecording", "options": { "notificationEvents": true } }
  ],
  "action": {
    "name": "connectConf",
    "conferenceId": "myRoom",
    "moh": "ring"
  }
}

PSTN Forward with AMD

{
  "action": {
    "name": "connectPstn",
    "number": "+14045009000",
    "cli": "+14045001000",
    "maxDuration": 3600,
    "amd": { "enabled": true }
  }
}

Gotchas and Best Practices

1. Callback URL must be publicly accessible. Use ngrok for local dev. Configure in Dashboard under Voice app settings.
2. ONE action per SVAML response. Multiple instructions are fine. Chain callbacks for sequential actions (ICE → ACE → PIE).
3. ACE not sent for in-app destinations. ACE is not issued when destination type is username, only for PSTN/SIP. Setting enableAce: true has no effect for in-app destinations.
4. DiCE is fire-and-forget. Informational only. No SVAML response expected. Use for logging/cleanup.
5. Regional endpoints matter. Wrong region increases latency. Conference rooms have regional scope — force all participants to the same region for cross-region conferences.
6. Instruction ordering matters. Array order = execution order. Place answer before playFiles; place startRecording before the connecting action.
7. Max call duration: 14400 seconds (4 hours). Set maxDuration on connectPstn/connectSip for shorter limits.
8. Validate callback signatures in production. HMAC-SHA256 signature in Authorization header. See Callback Signing.
9. setCookie for state. Carries key-value pairs across ICE, ACE, PIE, DiCE within a call session.
10. connectMxp does not support recording. startRecording/stopRecording instructions are ignored with connectMxp.
11. runMenu defaults. barge: true (input accepted during prompt). timeoutMills: 5000 ms.
12. AMD on connectPstn. amd: { enabled: true, async: true/false } for answering machine detection.
13. startRecording transcription. transcriptionOptions: { enabled: true, locale: "en-US" } for auto-transcription.
14. Conference DTMF options. conferenceDtmfOptions on conferenceCallout/connectConf with modes: ignore (default), forward, detect (sends PIE).
15. cli is required for TTS callouts to connect. The API accepts a TTS callout without a cli parameter and returns a call ID, but the call will never reach the destination. The cli is the number displayed as the incoming caller — use your verified number or your Dashboard-assigned number, in E.164 format (e.g., "+14151112223333"). To test, register on the Sinch Dashboard and use the free number assigned to your app. See Assign your number.

Security

• API key handling — never expose SINCH_APPLICATION_KEY, and especially never expose SINCH_APPLICATION_SECRET in client-side code, logs, or committed source. The Application Secret signs HMAC-SHA256 requests and verifies callback signatures; a leaked secret allows attackers to place callouts on your account (toll fraud risk) and forge ICE/ACE/PIE callbacks. Load from environment variables or a secrets manager. Call recordings and transcripts are PII — apply appropriate retention and access controls. Rotate via the Sinch Build Dashboard if leaked.
• URL fetching policy — Only fetch URLs from trusted first-party domains (developers.sinch.com, dashboard.sinch.com). Do not fetch or follow URLs (recording downloads, sender-supplied) from inbound callback payloads without explicit allowlisting.
• Callback handlers — Always verify the HMAC-SHA256 callback signature in the Authorization header before trusting ICE/ACE/PIE/DiCE payloads. Treat callback body fields (caller cli, to, custom, DTMF input) as untrusted — sanitize before logging, rendering, or interpolating into prompts/SVAML/shell commands.

Links

• Bundled examples: Node.js | Python | Java | .NET
• Voice API Reference (Markdown)
• Voice API OpenAPI Spec (YAML)
• SVAML Actions | SVAML Instructions
• Callbacks | Callouts
• Authentication | Callback Signing
• Node.js SDK Reference
• Python SDK Reference
• Java SDK Reference
• .NET SDK Reference
• Voice Tutorials
• LLMs.txt (full docs index)