Skip to content

SMSChannelResponse

Source code in docs_src/capo_pinpoint/types/sms_channel_response.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class SMSChannelResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the SMS channel applies to.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time, in ISO 8601 format, when the SMS channel was enabled.</p>"""
    enabled: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether the SMS channel is enabled for the application.</p>"""
    has_credential: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>(Not used) This property is retained only for backward compatibility.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.</p>"""
    is_archived: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether the SMS channel is archived.</p>"""
    last_modified_by: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The user who last modified the SMS channel.</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time, in ISO 8601 format, when the SMS channel was last modified.</p>"""
    platform: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.</p>"""
    promotional_messages_per_second: NotRequired[
        "capo_pinpoint.types.__integer.__integer"
    ]
    """<p>The maximum number of promotional messages that you can send through the SMS channel each second.</p>"""
    sender_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The identity that displays on recipients' devices when they receive messages from the SMS channel.</p>"""
    short_code: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The registered short code to use when you send messages through the SMS channel.</p>"""
    transactional_messages_per_second: NotRequired[
        "capo_pinpoint.types.__integer.__integer"
    ]
    """<p>The maximum number of transactional messages that you can send through the SMS channel each second.</p>"""
    version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The current version of the SMS channel.</p>"""

application_id instance-attribute 

application_id: NotRequired[__string]

The unique identifier for the application that the SMS channel applies to.

creation_date instance-attribute 

creation_date: NotRequired[__string]

The date and time, in ISO 8601 format, when the SMS channel was enabled.

enabled instance-attribute 

enabled: NotRequired[__boolean]

Specifies whether the SMS channel is enabled for the application.

has_credential instance-attribute 

has_credential: NotRequired[__boolean]

(Not used) This property is retained only for backward compatibility.

id instance-attribute 

id: NotRequired[__string]

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

is_archived instance-attribute 

is_archived: NotRequired[__boolean]

Specifies whether the SMS channel is archived.

last_modified_by instance-attribute 

last_modified_by: NotRequired[__string]

The user who last modified the SMS channel.

last_modified_date instance-attribute 

last_modified_date: NotRequired[__string]

The date and time, in ISO 8601 format, when the SMS channel was last modified.

platform instance-attribute 

platform: NotRequired[__string]

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

promotional_messages_per_second instance-attribute 

promotional_messages_per_second: NotRequired[__integer]

The maximum number of promotional messages that you can send through the SMS channel each second.

sender_id instance-attribute 

sender_id: NotRequired[__string]

The identity that displays on recipients' devices when they receive messages from the SMS channel.

short_code instance-attribute 

short_code: NotRequired[__string]

The registered short code to use when you send messages through the SMS channel.

transactional_messages_per_second instance-attribute 

transactional_messages_per_second: NotRequired[__integer]

The maximum number of transactional messages that you can send through the SMS channel each second.

version instance-attribute 

version: NotRequired[__integer]

The current version of the SMS channel.