Amazon Pinpoint · Schema
SMSMessageActivity
Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| MessageConfig | object | |
| NextActivity | object | |
| TemplateName | object | |
| TemplateVersion | object |
JSON Schema
{
"$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-message-activity-schema.json",
"title": "SMSMessageActivity",
"description": "Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.",
"type": "object",
"properties": {
"MessageConfig": {
"allOf": [
{
"$ref": "#/components/schemas/JourneySMSMessage"
},
{
"description": "Specifies the sender ID and message type for an SMS message that's sent to participants in a journey."
}
]
},
"NextActivity": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the next activity to perform, after the message is sent."
}
]
},
"TemplateName": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template."
}
]
},
"TemplateVersion": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "<p>The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"
}
]
}
}
}