Sign in
SMS Apps

Get SMS app by ID

Retrieves a single SMS app by its ID within a project.
get/v1/projects/{projectId}/sms/smsApps/{smsAppId}

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>.

smsAppIdstring required

Sms App id.

Response

SMS app details

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.

regionsSmsSmsAppRegionsEnum[] required

List of regions of the app.

testboolean required

True if the app is a test app.

Changes

Changed in 2 of the 4 revisions of this API.657

  • c6a937922d10656See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 404

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

    • ▲

      the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      removed subschema #1: UnauthorizedErrorErrorTitle subschema #2: UnauthorizedErrorErrorTitle from the response body oneOf list for the response status 401

      response-body-one-of-removed

    • ○

      added the optional property additionalInformation to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property additionalInformation to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property additionalInformation to the response with the 500 status

      response-optional-property-added

    • ○

      added SmsConversationApiAppRegionsEnum to the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added SmsConversationAppChannelIntegrationStatusEnum to the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added SmsProvisioningStatesEnum to the status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      the response property errorCode became required for the status 404

      response-property-became-required

    • ○

      the response property errorCode became required for the status 500

      response-property-became-required

    • ○

      the response property message became required for the status 404

      response-property-became-required

    • ○

      the response property message became required for the status 500

      response-property-became-required

    • ○

      the response property resolution became required for the status 404

      response-property-became-required

    • ○

      the response property resolution became required for the status 500

      response-property-became-required

    • ○

      removed the ACTIVE enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ACTIVE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BLOCKED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BR enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DELETED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DEPROVISIONING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DEPROVISIONING_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EU enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED_ADD enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED_BLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED_DELETE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED_UNBLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILED_UPDATE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the FAILING enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IN_PROGRESS_ADD enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IN_PROGRESS_BLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IN_PROGRESS_DELETE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IN_PROGRESS_UNBLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IN_PROGRESS_UPDATE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING_ADD enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING_BLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING_DELETE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING_UNBLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PENDING_UPDATE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_ADD enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_ADD_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_BLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_BLOCK_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_UNBLOCK enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_UNBLOCK_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_UPDATE enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROVISIONING_UPDATE_FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the STATUS_UNSPECIFIED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UNRECOGNIZED enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/channelStatus response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UNRECOGNIZED enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UNRECOGNIZED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the US enum value from the conversationApiAppDetails/allOf[SmsConversationApiAppDto]/region response property for the response status 200

      response-property-enum-value-removed

    • ○

      added the required property errorCode to the response with the 401 status

      response-required-property-added

    • ○

      added the required property message to the response with the 401 status

      response-required-property-added

    • ○

      added the required property resolution to the response with the 401 status

      response-required-property-added

  • c78a716de4201See the full diff
    • ○

      api operation id SmsAppsController_getSmsApp_v1 removed and replaced with SmsSmsAppsController_getSmsApp_v1

      api-operation-id-removed

Of the 4 revisions, 1 has no diff computed.