Sign in
latestOpenAPI 3.1.02026-08-18893023.3 MB

c78a716de420

SMS Apps

Create an sms app

Creates a new sms app for the given project.

post/v1/projects/{projectId}/sms/smsApps

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

Request body

namestring required

Name of SMS App to create.

region'BR' | 'EU' | 'US' required

Region to create SMS app. (Allowed values for staging environment: EU or US).

testboolean

Deprecated. This field is no longer used and will be removed in a future release.

convApiAppboolean

Flag to create a new Conversation App alongside this SMS App

convApiAppIdstring

Id of an existing Conversation API App to link with the new SMS App. Mutually exclusive with convApiApp.

Response

Newly created sms app

idstring required

SMS App id.

smsServiceIdstring required

Id of the SMS Service which the SMS App belongs to.

namestring required

Name of SMS App.

status'ACTIVE' | 'BLOCKED' | 'DELETED' | 'DEPROVISIONING' | 'DEPROVISIONING_FAILED' | 'FAILED_ADD' | 'FAILED_BLOCK' | 'FAILED_DELETE' | 'FAILED_UNBLOCK' | 'FAILED_UPDATE' | 'IN_PROGRESS_ADD' | 'IN_PROGRESS_BLOCK' | 'IN_PROGRESS_DELETE' | 'IN_PROGRESS_UNBLOCK' | 'IN_PROGRESS_UPDATE' | 'PENDING_ADD' | 'PENDING_BLOCK' | 'PENDING_DELETE' | 'PENDING_UNBLOCK' | 'PENDING_UPDATE' | 'PROVISIONING' | 'PROVISIONING_ADD' | 'PROVISIONING_ADD_FAILED' | 'PROVISIONING_BLOCK' | 'PROVISIONING_BLOCK_FAILED' | 'PROVISIONING_FAILED' | 'PROVISIONING_UNBLOCK' | 'PROVISIONING_UNBLOCK_FAILED' | 'PROVISIONING_UPDATE' | 'PROVISIONING_UPDATE_FAILED' | 'STATUS_UNSPECIFIED' | 'UNRECOGNIZED' required

Status of SMS App.

regionsstring[] required

List of regions of the app.

testboolean required

True if the app is a test app.