VoiceMessage is a JSON Structure definition published by Amazon Pinpoint, describing 5 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-voice-message-structure.json",
"name": "VoiceMessage",
"description": "Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.",
"type": "object",
"properties": {
"Body": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The text of the script to use for the voice message."
}
]
},
"LanguageCode": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/what-is.html\">Amazon Polly Developer Guide</a>."
}
]
},
"OriginationNumber": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message."
}
]
},
"Substitutions": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfListOf__string"
},
{
"description": "The default message variables to use in the voice message. You can override the default variables with individual address variables."
}
]
},
"VoiceId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the voice to use when delivering the message. For a list of supported voices, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/what-is.html\">Amazon Polly Developer Guide</a>."
}
]
}
}
}
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.