Skip to content

VoiceMessage

Source code in docs_src/capo_pinpoint/types/voice_message.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class VoiceMessage(TypedDict, closed=True):
    body: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The text of the script to use for the voice message.</p>"""
    language_code: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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>.</p>"""
    origination_number: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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.</p>"""
    substitutions: NotRequired[
        "capo_pinpoint.types.map_of_list_of__string.MapOfListOf__string"
    ]
    """<p>The default message variables to use in the voice message. You can override the default variables with individual address variables.</p>"""
    voice_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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>.</p>"""

body instance-attribute 

body: NotRequired[__string]

The text of the script to use for the voice message.

language_code instance-attribute 

language_code: NotRequired[__string]

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 Amazon Polly Developer Guide.

origination_number instance-attribute 

origination_number: NotRequired[__string]

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 instance-attribute 

substitutions: NotRequired[MapOfListOf__string]

The default message variables to use in the voice message. You can override the default variables with individual address variables.

voice_id instance-attribute 

voice_id: NotRequired[__string]

The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.