{
"$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-voice-template-request-schema.json",
"title": "VoiceTemplateRequest",
"description": "Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.",
"type": "object",
"properties": {
"Body": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The text of the script to use in messages that are based on the message template, in plain text format."
}
]
},
"DefaultSubstitutions": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values."
}
]
},
"LanguageCode": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/MapOf__string"
},
{
"description": "A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value."
}
]
},
"TemplateDescription": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "A custom description of the message template."
}
]
},
"VoiceId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide."
}
]
}
}
}