Skip to content

CampaignSmsMessage

Source code in docs_src/capo_pinpoint/types/campaign_sms_message.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class CampaignSmsMessage(TypedDict, closed=True):
    body: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The body of the SMS message.</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 long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</p>"""
    sender_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The sender ID to display on recipients' devices when they receive the SMS message.</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.

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 long code to send the SMS 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 using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

sender_id instance-attribute 

sender_id: NotRequired[__string]

The sender ID to display on recipients' devices when they receive the SMS message.

template_id instance-attribute 

template_id: NotRequired[__string]

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