SMSMessage is a JSON Structure definition published by Amazon Pinpoint, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$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-message-structure.json",
"name": "SMSMessage",
"description": "Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.",
"type": "object",
"properties": {
"Body": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The body of the SMS message."
}
]
},
"Keyword": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The SMS program name that you provided to AWS Support when you requested your dedicated number."
}
]
},
"MediaUrl": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "This field is reserved for future use."
}
]
},
"MessageType": {
"allOf": [
{
"$ref": "#/components/schemas/MessageType"
},
{
"description": "The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages)."
}
]
},
"OriginationNumber": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code."
}
]
},
"SenderId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region."
}
]
},
"Substitutions": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfListOf__string"
},
{
"description": "The message variables to use in the SMS message. You can override the default variables with individual address variables."
}
]
},
"EntityId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country."
}
]
},
"TemplateId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The template ID received from the regulatory body for sending SMS in your country."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.