Amazon Pinpoint · Schema

SMSChannelRequest

Specifies the status and settings of the SMS channel for an application.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Enabled object
SenderId object
ShortCode object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-sms-channel-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-sms-channel-request-schema.json",
  "title": "SMSChannelRequest",
  "description": "Specifies the status and settings of the SMS channel for an application.",
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether to enable the SMS channel for the application."
        }
      ]
    },
    "SenderId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The identity that you want to display on recipients' devices when they receive messages from the SMS channel."
        }
      ]
    },
    "ShortCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The registered short code that you want to use when you send messages through the SMS channel."
        }
      ]
    }
  }
}