Skip to content

SendNotifyVoiceMessageRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/send_notify_voice_message_request.py
class SendNotifyVoiceMessageRequest(TypedDict, closed=True):
    notify_configuration_id: "capo_pinpoint_sms_voice_v2.types.notify_configuration_id_or_arn.NotifyConfigurationIdOrArn"
    """<p>The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.</p>"""
    destination_phone_number: (
        "capo_pinpoint_sms_voice_v2.types.phone_number.PhoneNumber"
    )
    """<p>The destination phone number in E.164 format.</p>"""
    template_id: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_template_id.NotifyTemplateId"
    ]
    """<p>The unique identifier of the template to use for the message.</p>"""
    template_variables: "capo_pinpoint_sms_voice_v2.types.template_variable_substitution_map.TemplateVariableSubstitutionMap"
    """<p>A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass <code>INTEGER</code> values as <code>"42"</code> and <code>BOOLEAN</code> values as <code>"true"</code> or <code>"false"</code>.</p>"""
    voice_id: NotRequired["capo_pinpoint_sms_voice_v2.types.voice_id.VoiceId"]
    """<p>The voice ID to use for the voice message.</p>"""
    time_to_live: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.time_to_live.TimeToLive"
    ]
    """<p>How long the voice message is valid for, in seconds. By default this is 72 hours.</p>"""
    context: NotRequired["capo_pinpoint_sms_voice_v2.types.context_map.ContextMap"]
    """<p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>"""
    configuration_set_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.configuration_set_name_or_arn.ConfigurationSetNameOrArn"
    ]
    """<p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>"""
    dry_run: "bool"
    """<p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>"""
    message_feedback_enabled: NotRequired["bool"]
    """<p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <a>PutMessageFeedback</a>.</p>"""

configuration_set_name instance-attribute

configuration_set_name: NotRequired[ConfigurationSetNameOrArn]

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

context instance-attribute

context: NotRequired[ContextMap]

You can specify custom data in this field. If you do, that data is logged to the event destination.

destination_phone_number instance-attribute

destination_phone_number: PhoneNumber

The destination phone number in E.164 format.

dry_run instance-attribute

dry_run: bool

When set to true, the message is checked and validated, but isn't sent to the end recipient.

message_feedback_enabled instance-attribute

message_feedback_enabled: NotRequired[bool]

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

notify_configuration_id instance-attribute

notify_configuration_id: NotifyConfigurationIdOrArn

The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.

template_id instance-attribute

template_id: NotRequired[NotifyTemplateId]

The unique identifier of the template to use for the message.

template_variables instance-attribute

template_variables: TemplateVariableSubstitutionMap

A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".

time_to_live instance-attribute

time_to_live: NotRequired[TimeToLive]

How long the voice message is valid for, in seconds. By default this is 72 hours.

voice_id instance-attribute

voice_id: NotRequired[VoiceId]

The voice ID to use for the voice message.