{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/provisioning-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"product":"Provisioning API","type":"markdown"},"seo":{"title":"Managing SMS Apps using Provisioning API | Provisioning API | 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","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":"Learn how to create, list, update, and delete SMS Apps using Provisioning API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sms-apps","__idx":0},"children":["SMS Apps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An SMS App represents a configured SMS sender tied to a specific region. Once provisioned, it can be used with the Sinch Conversation API to send SMS messages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["What you'll find here:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prerequisites: account, project credentials, and project ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Creating an SMS App: request shape and sample code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Connecting an SMS App to a Conversation Application (post-creation)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Listing SMS Apps: paginated retrieval"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Updating an SMS App: changing the name"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deleting an SMS App"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before creating an SMS App, ensure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Sinch account: Register and sign in via Sinch Build: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/"},"children":["dashboard.sinch.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Project credentials: Create an Access Key and Access Secret for the specific project you intend to use. These credentials authenticate calls to Provisioning API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Project ID: The UUID of the project that will own the SMS App and Conversation App."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Quick links:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sinch Build dashboard: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/"},"children":["dashboard.sinch.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create project credentials: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["Access Keys"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-an-sms-app","__idx":2},"children":["Creating an SMS App"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Node.js"]}," code sample demonstrates how to create a new SMS App for a specific project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function createSmsApp() {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n      body: JSON.stringify({\n        name: 'My SMS App',\n        region: 'EU',\n      }),\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-an-sms-app-with-a-new-conversation-application","__idx":3},"children":["Creating an SMS App with a new Conversation Application"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To automatically create a linked Conversation Application alongside the SMS App, set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function createSmsAppWithConvApp() {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n      body: JSON.stringify({\n        name: 'My SMS App with Conversation',\n        region: 'US',\n        convApiApp: true,\n      }),\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-an-sms-app-linked-to-an-existing-conversation-application","__idx":4},"children":["Creating an SMS App linked to an existing Conversation Application"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To link the SMS App to an existing Conversation Application, provide its ID via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function createSmsAppWithExistingConvApp() {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n      body: JSON.stringify({\n        name: 'My SMS App linked',\n        region: 'BR',\n        convApiAppId: 'your-existing-conversation-app-id',\n      }),\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You cannot provide both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp: true"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]}," in the same request. Use one or the other."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All create variants return an SMS App object:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"01fc866f5e3e48c9a6fd0e8de407459a\",\n  \"smsServiceId\": \"a3f2b8c14d5e6f7890abcdef12345678\",\n  \"name\": \"My SMS App\",\n  \"status\": \"PENDING_ADD\",\n  \"regions\": [\"EU\"],\n  \"conversationApiAppDetails\": {\n    \"id\": \"01KSHM8N1YZNCGAC24JK3B9VBQ\",\n    \"projectId\": \"e1a2b3c4-d5e6-f7a8-b9c0-d1e2f3a4b5c6\",\n    \"region\": \"EU\",\n    \"channelStatus\": \"PENDING\"\n  },\n  \"test\": false\n}\n","lang":"json"},"children":[]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the SMS App (UUID without hyphens). This is the resource you interact with for all SMS App operations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsServiceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The parent SMS Service container ID. One SMS Service is created per project (on the first SMS App creation) and shared by all SMS Apps in that project."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the SMS App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provisioning status — typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING_ADD"]}," on creation, transitioning to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," once fully provisioned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Regions the SMS App is provisioned in (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},"). Always a single-element array matching the input ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["region"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object | undefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Linked Conversation Application details (present when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]}," was used)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conversation Application ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails.projectId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Project ID the Conversation App belongs to"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails.region"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Region of the Conversation App (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BR"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails.channelStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string | undefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS channel integration status on the Conversation App (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FAILING"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this is a test SMS App"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field will be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING_ADD"]}," immediately after creation. It transitions through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS_ADD"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," as the upstream SMS platform completes provisioning. When using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]},", the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelStatus"]}," will also initially be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]}," and transition to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," asynchronously. For standalone creation (no conv app flags), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails"]}," will be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["undefined"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"connecting-an-sms-app-to-a-conversation-application","__idx":6},"children":["Connecting an SMS App to a Conversation Application"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you created an SMS App without linking it at creation time, you can connect it to a Conversation Application afterwards using the channels endpoint on the Conversation service."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is also the mechanism used in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/provisioning-api/getting-started/sms"},"children":["three-request creation flow"]}," when you want full control over each resource."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function connectSmsAppToConvApp(convAppId, smsAppId) {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/conversation/apps/${convAppId}/channels/connectSender`,\n    {\n      method: 'PATCH',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n      body: JSON.stringify({\n        senderId: smsAppId,\n        channel: 'SMS',\n      }),\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request body:"]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["senderId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ID of the SMS App to connect"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Region requirement"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the SMS App region and the Conversation Application region do not match, the request will fail."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-an-sms-app-using-bundles","__idx":7},"children":["Creating an SMS App using Bundles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also use the Bundles endpoint to create the SMS App and Conversation Application together in a single atomic request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"POST /v1/projects/:projectId/bundles\n\n{\n  \"name\": \"My SMS Setup\",\n  \"region\": \"EU\",\n  \"smsApp\": true,\n  \"convApp\": true\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Bundles endpoint also supports linking existing SMS Apps (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsApp: { smsAppId: \"...\" }"]},") and existing Conv Apps (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApp: { convAppId: \"...\" }"]},"), creating subprojects, and registering webhooks — all in one atomic request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/provisioning-api/getting-started/bundles/sms-apps"},"children":["Bundles guide"]}," for full details."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Async processing"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both the SMS endpoint (with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]},") and the Bundles endpoint process linking asynchronously. The SMS channel activation on the Conversation App transitions through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," behind the scenes. Register a webhook with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUNDLE_DONE"]}," trigger to be notified when the process completes."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"listing-sms-apps","__idx":8},"children":["Listing SMS Apps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a paginated list of SMS Apps for your project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function listSmsApps(pageToken, pageSize) {\n  const params = new URLSearchParams();\n  if (pageToken) params.set('pageToken', pageToken);\n  if (pageSize) params.set('pageSize', pageSize);\n\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps?${params}`,\n    {\n      method: 'GET',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes:"]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of SMS Apps in the project"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of items returned in this page"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousPageToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token for the previous page (if available)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPageToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token for the next page (if available)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsApps"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of SMS App objects"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieving-an-sms-app","__idx":9},"children":["Retrieving an SMS App"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get details of a specific SMS App by its ID:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function getSmsApp(smsAppId) {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps/${smsAppId}`,\n    {\n      method: 'GET',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes:"]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the SMS App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsServiceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The associated SMS service ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the SMS App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current provisioning status (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS_ADD"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of regions the SMS App is available in"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Linked Conversation App details (if any)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether this is a test SMS App"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"updating-an-sms-app","__idx":10},"children":["Updating an SMS App"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update the name of an existing SMS App:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function updateSmsApp(smsAppId) {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps/${smsAppId}`,\n    {\n      method: 'PATCH',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n      body: JSON.stringify({\n        name: 'Updated SMS App Name',\n      }),\n    }\n  );\n\n  const data = await response.json();\n  return data;\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deleting-an-sms-app","__idx":11},"children":["Deleting an SMS App"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete an SMS App by its ID:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"import fetch from 'node-fetch';\n\nasync function deleteSmsApp(smsAppId) {\n  const response = await fetch(\n    `https://provisioning.api.sinch.com/v1/projects/${PROJECT_ID}/sms/smsApps/${smsAppId}`,\n    {\n      method: 'DELETE',\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization:\n          'Basic ' +\n          Buffer.from(ACCESS_KEY + ':' + ACCESS_SECRET).toString('base64'),\n      },\n    }\n  );\n\n  if (response.status === 200) {\n    console.log('SMS App deleted successfully');\n  }\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deleting an SMS App is irreversible. The associated SMS service will be deprovisioned."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"conversation-app-lifecycle","__idx":12},"children":["Conversation App lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SMS Apps that are linked to a Conversation Application are subject to the following lifecycle rules:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation App deleted"]}," — If the linked Conversation Application is deleted, the SMS App is also deleted automatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SMS channel removed"]}," — If the SMS channel is removed from the linked Conversation Application, the SMS App is deactivated."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"conversation-app-details-in-sms-app-responses","__idx":13},"children":["Conversation App details in SMS App responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you fetch an SMS App (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},") or list SMS Apps (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LIST"]},"), the response includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails"]}," field that shows which Conversation Application the SMS App is linked to and its channel integration status:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"01ABC1234DEF56789ABC1234\",\n  \"smsServiceId\": \"a1b2c3d4e5f6\",\n  \"name\": \"My SMS App\",\n  \"status\": \"ACTIVE\",\n  \"regions\": [\"EU\"],\n  \"conversationApiAppDetails\": {\n    \"id\": \"4CF9CE97504C4A468F4610919D17ECC1\",\n    \"projectId\": \"ea026751-3edf-40a9-ad93-1b382bd60a78\",\n    \"region\": \"EU\",\n    \"channelStatus\": \"ACTIVE\"\n  },\n  \"test\": false\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conversationApiAppDetails"]}," is present when the SMS App is linked to a Conversation Application."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["undefined"]}," (omitted from the response) when the SMS App was just created and not yet linked, or if no matching Conversation App exists."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelStatus"]}," reflects the SMS channel integration state on the Conversation App: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INACTIVE"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":14},"children":["Error responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following errors may be returned by the SMS provisioning endpoints:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-sms-app","__idx":15},"children":["Create SMS App"]},{"$$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":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["409"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS_APP_REGION_MISMATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS app region does not match the bundle region."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The SMS App region doesn't match the Conversation App's region (when using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiApp"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONVERSATION_APP_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conversation app not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["convApiAppId"]}," provided doesn't exist in the project's region"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["409"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS_APP_IS_ALREADY_LINKED_TO_CONVERSATION_APP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SmsApp is already linked to ConversationApp."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attempting to link an SMS App that already has a Conversation App association"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-sms-app","__idx":16},"children":["Get SMS App"]},{"$$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":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS_APP_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SmsApp not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsAppId"]}," doesn't exist in the project"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-sms-app","__idx":17},"children":["Update SMS App"]},{"$$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":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NO_FIELDS_TO_UPDATE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No fields to be updated."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request body contains no valid fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS_APP_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SmsApp not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsAppId"]}," doesn't exist in the project"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-sms-app","__idx":18},"children":["Delete SMS App"]},{"$$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":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS_APP_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SmsApp not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smsAppId"]}," doesn't exist in the project"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connect-sms-app-to-conversation-application","__idx":19},"children":["Connect SMS App to Conversation Application"]},{"$$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":"HTTP"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Code"},"children":["Error Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SENDER_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sender not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["senderId"]}," (SMS App ID) doesn't exist in the project"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONVERSATION_APP_NOT_FOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conversation app not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Conversation Application ID doesn't exist in the project."]}]}]}]}]}]},"headings":[{"value":"SMS Apps","id":"sms-apps","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Creating an SMS App","id":"creating-an-sms-app","depth":2},{"value":"Creating an SMS App with a new Conversation Application","id":"creating-an-sms-app-with-a-new-conversation-application","depth":3},{"value":"Creating an SMS App linked to an existing Conversation Application","id":"creating-an-sms-app-linked-to-an-existing-conversation-application","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Connecting an SMS App to a Conversation Application","id":"connecting-an-sms-app-to-a-conversation-application","depth":2},{"value":"Creating an SMS App using Bundles","id":"creating-an-sms-app-using-bundles","depth":2},{"value":"Listing SMS Apps","id":"listing-sms-apps","depth":2},{"value":"Retrieving an SMS App","id":"retrieving-an-sms-app","depth":2},{"value":"Updating an SMS App","id":"updating-an-sms-app","depth":2},{"value":"Deleting an SMS App","id":"deleting-an-sms-app","depth":2},{"value":"Conversation App lifecycle","id":"conversation-app-lifecycle","depth":2},{"value":"Conversation App details in SMS App responses","id":"conversation-app-details-in-sms-app-responses","depth":2},{"value":"Error responses","id":"error-responses","depth":2},{"value":"Create SMS App","id":"create-sms-app","depth":3},{"value":"Get SMS App","id":"get-sms-app","depth":3},{"value":"Update SMS App","id":"update-sms-app","depth":3},{"value":"Delete SMS App","id":"delete-sms-app","depth":3},{"value":"Connect SMS App to Conversation Application","id":"connect-sms-app-to-conversation-application","depth":3}],"frontmatter":{"seo":{"title":"Managing SMS Apps using Provisioning API | Provisioning API | Sinch","description":"Learn how to create, list, update, and delete SMS Apps using Provisioning API."},"disableRating":true},"lastModified":"2026-07-23T02:53:41.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/provisioning-api/getting-started/sms/sms-apps","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}