{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/functions/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"type":"markdown"},"seo":{"title":"Developer Documentation","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":"SMS API","description":"The SMS API allows you to send and receive SMS messages with a few easy steps. You can also send bulk SMS messages to multiple customers using the Sinch SMS service.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md"]},{"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","description":"The 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","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/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"]}],"hide":false,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"architecture","__idx":0},"children":["Architecture"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page walks through the moving parts so you have a mental model of where your code sits and what runs where."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-big-picture","__idx":1},"children":["The big picture"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"flowchart LR\n Dev[\"Your laptop
sinch CLI\"]\n Platform[\"Sinch Functions Platform\"]\n Fn[\"Your deployed Function\"]\n VP[\"Voice Platform\"]\n CP[\"Conversation Platform
(SMS, WhatsApp, etc.)\"]\n Phone([\"Phone network\"])\n Chat([\"Messaging channels\"])\n\n Dev -- \"deploy\" --> Platform\n Platform -- \"runs\" --> Fn\n Phone -- \"incoming call\" --> VP\n Chat -- \"inbound message\" --> CP\n VP -- \"ICE / ACE / PIE / DICE\" --> Fn\n CP -- \"webhook\" --> Fn\n Fn -. \"SDK calls
context.voice\" .-> VP\n Fn -. \"SDK calls
context.conversation\" .-> CP\n","diagramHtml":"

deploy

runs

incoming call

inbound message

ICE / ACE / PIE / DICE

webhook

SDK calls
context.voice

SDK calls
context.conversation

Your laptop
sinch CLI

Sinch Functions Platform

Your deployed Function

Voice Platform

Conversation Platform
(SMS, WhatsApp, etc.)

Phone network

Messaging channels

"},"children":["flowchart LR\n Dev[\"Your laptop
sinch CLI\"]\n Platform[\"Sinch Functions Platform\"]\n Fn[\"Your deployed Function\"]\n VP[\"Voice Platform\"]\n CP[\"Conversation Platform
(SMS, WhatsApp, etc.)\"]\n Phone([\"Phone network\"])\n Chat([\"Messaging channels\"])\n\n Dev -- \"deploy\" --> Platform\n Platform -- \"runs\" --> Fn\n Phone -- \"incoming call\" --> VP\n Chat -- \"inbound message\" --> CP\n VP -- \"ICE / ACE / PIE / DICE\" --> Fn\n CP -- \"webhook\" --> Fn\n Fn -. \"SDK calls
context.voice\" .-> VP\n Fn -. \"SDK calls
context.conversation\" .-> CP\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The CLI uploads your source and configuration to the Sinch Functions Platform. From there, the platform builds your function, runs it, and updates any callback URLs on your Voice or Conversation apps so inbound traffic reaches the new version."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-happens-when-you-deploy","__idx":2},"children":["What happens when you deploy"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch functions deploy"]}," from your project directory."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The CLI validates your project:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Node:"]}," typecheck, bundle with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tsup"]},", smoke-test."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["C#:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dotnet build"]},", health-check locally."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The CLI packages the project into a zip and uploads it to the Sinch Functions Platform."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The platform builds and rolls out your function. If an identical build already exists, the build step is skipped and the existing artifact is reused."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your function comes up at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://fn-.functions.sinch.com"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If your project's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch.json"]}," declares a Voice App or Conversation App, the CLI updates that app's callback URL to point at the new function."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-happens-when-a-call-arrives","__idx":3},"children":["What happens when a call arrives"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A caller dials your Sinch phone number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sinch's voice platform receives the call and looks up the Voice App assigned to that number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Voice App sends an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ICE"]}," (Incoming Call Event) callback to your function's URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your function runs, builds a SVAML response, returns it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sinch interprets the SVAML and controls the call accordingly — plays audio, runs menus, connects legs, records, etc."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the SVAML ran a menu, Sinch sends a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PIE"]}," (Prompt Input Event) callback when the menu completes. You respond with the next SVAML step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When the call ends, Sinch sends a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DICE"]}," (Disconnected Call Event) callback. Your function can log or clean up."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["voice-callbacks"]}," for the callback lifecycle in detail."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-happens-when-a-message-arrives","__idx":4},"children":["What happens when a message arrives"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A user sends an SMS or WhatsApp message to a number assigned to your Conversation App."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Conversation platform posts a webhook to your function's URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your function runs, decides what to do, and optionally sends a reply via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["context.conversation.messages.send(...)"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-happens-when-you-run-sinch-functions-dev","__idx":5},"children":["What happens when you run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch functions dev"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The CLI starts your function locally — hot-reloading via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tsup"]}," watch (Node) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dotnet watch"]}," (C#)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It opens a tunnel (Cloudflare Tunnel) that gives your local process a public URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It optionally updates your Voice App's callback URL to the tunnel URL so Sinch can reach your laptop directly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When a real call hits the number, Sinch calls your laptop, and you see requests in real time via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch functions logs"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stop the dev server and the CLI reverts any callback URLs it touched."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This means you can test against real Sinch traffic from your laptop, with no deploy loop."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"where-secrets-live","__idx":6},"children":["Where secrets live"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Where"},"children":["Where"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What"},"children":["What"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Who manages it"},"children":["Who manages it"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OS keychain (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keytar"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CLI login credentials — API keys for the Sinch platform"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The CLI itself, via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch auth login"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your project's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".env"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Local development variables (dev loop only)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You, during ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch dev"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch.json"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variables"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Non-secret function config (e.g., feature flags, upstream URLs)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Checked into your repo"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch.json"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secrets"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch secrets add"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production secrets (e.g., ElevenLabs API key, OpenAI key)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You; stored encrypted in the platform, injected at runtime"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["configuration-secrets"]}," for the full story of how each layer is resolved."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"where-your-deployed-function-runs","__idx":7},"children":["Where your deployed function runs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deployed functions run in an isolated, managed runtime environment. The platform provides:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cache"]}," — persistent and shared across invocations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Blob storage"]}," — durable and backed up"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SQLite database"]}," — with automatic durable replication, so it survives restarts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Per-function subdomain"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://fn-.functions.sinch.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Auto-scaling"]}," based on request volume"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Structured logging"]}," streamed via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch functions logs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-initialized SDK clients"]}," for Voice, Conversation, SMS, Numbers (and Verification in C#) when the right environment variables are set"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You don't see any of this infrastructure from your code. You write a handler, the runtime takes care of the rest."]}]},"headings":[{"value":"Architecture","id":"architecture","depth":1},{"value":"The big picture","id":"the-big-picture","depth":2},{"value":"What happens when you deploy","id":"what-happens-when-you-deploy","depth":2},{"value":"What happens when a call arrives","id":"what-happens-when-a-call-arrives","depth":2},{"value":"What happens when a message arrives","id":"what-happens-when-a-message-arrives","depth":2},{"value":"What happens when you run sinch functions dev","id":"what-happens-when-you-run-sinch-functions-dev","depth":2},{"value":"Where secrets live","id":"where-secrets-live","depth":2},{"value":"Where your deployed function runs","id":"where-your-deployed-function-runs","depth":2}],"frontmatter":{"seo":{"title":""}},"lastModified":"2026-04-15T14:23:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/functions/concepts/architecture","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}