{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/campaigns/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cardSteps","admonition"]},"type":"markdown"},"seo":{"title":"Getting started","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","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"]},{"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/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for every Sinch API and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]},"description":"Get started with Campaigns API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"CardSteps","attributes":{"steps":[{"title":"Step 1","description":"Get your Project ID","icon":"sms","link":"#1-get-your-project-id"},{"title":"Step 2","description":"Get credentials","icon":"check","link":"#2-get-credentials"},{"title":"Step 3","description":"Register campaigns","icon":"pointer","link":"#3-register-campaigns"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide shows how to get started using the Campaigns API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you can begin registering campaigns, you need to complete some basic configuration steps:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's get started!"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Account required!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the Campaigns API requires ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://community.sinch.com/t5/Customer-Dashboard/How-to-sign-up-for-your-free-Sinch-account/ta-p/8058"},"children":["signing up for a free account"]}," on the Sinch Build Dashboard. If you haven't already done so, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/signup"},"children":["sign up now"]},"!"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-get-your-project-id","__idx":1},"children":["1. Get your Project ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Get your Project ID"]},". Next, you'll need your project ID, which can be found in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":["Sinch Build Dashboard"]}," under ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Setting"]},", then ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Projects"]},". Copy your Project ID and keep it handy. You'll need it for every endpoint in the Campaigns API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-get-credentials","__idx":2},"children":["2. Get credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Get your Access Key and Access Secret"]},". The access key and access secret will ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["serve as your username name and password for this API"]},". These access keys are also found in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["Sinch Build Dashboard"]},". Go to ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Settings"]},", then ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Access keys"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The access key will be readily visible. The access secret, however, will only be visible upon new key creation. Create a new key and then save your access secret in a safe place."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will need both the access key and the access secret for every endpoint in the Campaigns API."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-register-campaigns","__idx":3},"children":["3. Register campaigns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now, you're ready to register campaigns. The following guides are available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/campaigns/getting-started/register-campaign"},"children":["Register a campaign"]}]}]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"1. Get your Project ID","id":"1-get-your-project-id","depth":2},{"value":"2. Get credentials","id":"2-get-credentials","depth":2},{"value":"3. Register campaigns","id":"3-register-campaigns","depth":2}],"frontmatter":{"seo":{"title":"Getting started","description":"Get started with Campaigns API."},"steps":[{"title":"Step 1","description":"Get your Project ID","icon":"sms","link":"#1-get-your-project-id"},{"title":"Step 2","description":"Get credentials","icon":"check","link":"#2-get-credentials"},{"title":"Step 3","description":"Register campaigns","icon":"pointer","link":"#3-register-campaigns"}],"excludeFromSearch":true},"lastModified":"2025-11-18T21:51:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/campaigns/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}