Skip to content

SMSMessage

Source code in docs_src/capo_pinpoint/types/sms_message.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class SMSMessage(TypedDict, closed=True):
    body: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The body of the SMS message.</p>"""
    keyword: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The SMS program name that you provided to AWS Support when you requested your dedicated number.</p>"""
    media_url: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>This field is reserved for future use.</p>"""
    message_type: NotRequired["capo_pinpoint.types.message_type.MessageType"]
    """<p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>"""
    origination_number: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.</p>"""
    sender_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.</p>"""
    substitutions: NotRequired[
        "capo_pinpoint.types.map_of_list_of__string.MapOfListOf__string"
    ]
    """<p>The message variables to use in the SMS message. You can override the default variables with individual address variables.</p>"""
    entity_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</p>"""
    template_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The template ID received from the regulatory body for sending SMS in your country.</p>"""

body instance-attribute 

body: NotRequired[__string]

The body of the SMS message.

entity_id instance-attribute 

entity_id: NotRequired[__string]

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

keyword instance-attribute 

keyword: NotRequired[__string]

The SMS program name that you provided to AWS Support when you requested your dedicated number.

media_url instance-attribute 

media_url: NotRequired[__string]

This field is reserved for future use.

message_type instance-attribute 

message_type: NotRequired[MessageType]

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

origination_number instance-attribute 

origination_number: NotRequired[__string]

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

sender_id instance-attribute 

sender_id: NotRequired[__string]

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

substitutions instance-attribute 

substitutions: NotRequired[MapOfListOf__string]

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

template_id instance-attribute 

template_id: NotRequired[__string]

The template ID received from the regulatory body for sending SMS in your country.