Skip to content

RequestSenderIdRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/request_sender_id_request.py
class RequestSenderIdRequest(TypedDict, closed=True):
    sender_id: "capo_pinpoint_sms_voice_v2.types.sender_id.SenderId"
    """<p>The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen.</p>"""
    iso_country_code: "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode"
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>"""
    message_types: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.message_type_list.MessageTypeList"
    ]
    """<p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.</p>"""
    deletion_protection_enabled: NotRequired["bool"]
    """<p>By default this is set to false. When set to true the sender ID can't be deleted.</p>"""
    tags: NotRequired["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"]
    """<p>An array of tags (key and value pairs) to associate with the sender ID.</p>"""
    client_token: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: NotRequired[bool]

By default this is set to false. When set to true the sender ID can't be deleted.

iso_country_code instance-attribute

iso_country_code: IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

message_types instance-attribute

message_types: NotRequired[MessageTypeList]

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

sender_id instance-attribute

sender_id: SenderId

The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen.

tags instance-attribute

tags: NotRequired[TagList]

An array of tags (key and value pairs) to associate with the sender ID.