Amazon Pinpoint · JSON Structure

Amazon Pinpoint Sms Channel Request Structure

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

Type: object Properties: 3
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

SMSChannelRequest is a JSON Structure definition published by Amazon Pinpoint, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Enabled SenderId ShortCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-sms-channel-request-structure.json",
  "name": "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."
        }
      ]
    }
  }
}