{"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":"quickstart","__idx":0},"children":["Quickstart"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deploy a voice function from zero in about five minutes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["CLI installed: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm install -g @sinch/cli"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authenticated: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sinch auth login"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have not done these yet, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/functions/cli/installation"},"children":["Installation"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1--authenticate","__idx":2},"children":["Step 1 — Authenticate"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch auth login\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The CLI prompts for your Project ID, Key ID, and Key Secret. Skip if already authenticated."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2--initialize-a-function","__idx":3},"children":["Step 2 — Initialize a function"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch functions init simple-voice-ivr --name my-first-function\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The CLI downloads the template and creates a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["my-first-function/"]}," directory. For Node.js, it runs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm install"]}," automatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To see all available templates:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch templates list\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3--enter-the-project-directory","__idx":4},"children":["Step 3 — Enter the project directory"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"cd my-first-function\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4--start-the-local-development-server","__idx":5},"children":["Step 4 — Start the local development server"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch functions dev\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}," when prompted about the tunnel to get a public URL that Sinch can reach. Leave this terminal running."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5--test-locally-with-curl","__idx":6},"children":["Step 5 — Test locally with curl"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In a second terminal:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -s -X POST http://localhost:3000/ice \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"callid\":\"test-123\",\"cli\":\"+15551234567\",\"to\":{\"type\":\"number\",\"endpoint\":\"+15559876543\"},\"domain\":\"pstn\",\"originationType\":\"pstn\"}' \\\n  | cat\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You should receive a SVAML response with a voice menu."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-6--deploy","__idx":7},"children":["Step 6 — Deploy"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch functions deploy\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The CLI packages your code, uploads it, and streams deployment progress:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Deployment Complete!\n  Function: my-first-function\n  Status: Running\n  URL: https://fn-<id>.functions.sinch.com\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For C# functions, the CLI builds and health-checks locally before packaging."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-7--watch-logs","__idx":8},"children":["Step 7 — Watch logs"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"sinch functions logs --follow\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Opens an interactive terminal UI showing each request. Arrow keys to navigate, Enter to expand, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["q"]}," to exit."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whats-next","__idx":9},"children":["What's next"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["Local development"]}," — hot reload, debugging, secrets"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["Build an IVR guide"]}," — menus, DTMF, call routing patterns"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["Templates"]}," — all available starting points"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/functions/cli/overview"},"children":["CLI reference"]}," — full command reference"]}]}]},"headings":[{"value":"Quickstart","id":"quickstart","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Step 1 — Authenticate","id":"step-1--authenticate","depth":2},{"value":"Step 2 — Initialize a function","id":"step-2--initialize-a-function","depth":2},{"value":"Step 3 — Enter the project directory","id":"step-3--enter-the-project-directory","depth":2},{"value":"Step 4 — Start the local development server","id":"step-4--start-the-local-development-server","depth":2},{"value":"Step 5 — Test locally with curl","id":"step-5--test-locally-with-curl","depth":2},{"value":"Step 6 — Deploy","id":"step-6--deploy","depth":2},{"value":"Step 7 — Watch logs","id":"step-7--watch-logs","depth":2},{"value":"What's next","id":"whats-next","depth":2}],"frontmatter":{"seo":{"title":""}},"lastModified":"2026-04-15T14:23:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/functions/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}