Skip to content

ReleasePhoneNumberResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/release_phone_number_result.py
class ReleasePhoneNumberResult(TypedDict, closed=True):
    phone_number_arn: NotRequired["str"]
    """<p>The PhoneNumberArn of the phone number that was released.</p>"""
    phone_number_id: NotRequired["str"]
    """<p>The PhoneNumberId of the phone number that was released.</p>"""
    phone_number: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.phone_number.PhoneNumber"
    ]
    """<p>The phone number that was released.</p>"""
    status: NotRequired["capo_pinpoint_sms_voice_v2.types.number_status.NumberStatus"]
    """<p>The current status of the request.</p>"""
    iso_country_code: NotRequired[
        "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_type: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.message_type.MessageType"
    ]
    """<p>The message type that was associated with the phone number.</p>"""
    number_capabilities: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.number_capability_list.NumberCapabilityList"
    ]
    """<p>Specifies if the number could be used for text messages, voice, or both.</p>"""
    number_type: NotRequired["capo_pinpoint_sms_voice_v2.types.number_type.NumberType"]
    """<p>The type of number that was released.</p>"""
    monthly_leasing_price: NotRequired["str"]
    """<p>The monthly price of the phone number, in US dollars.</p>"""
    two_way_enabled: "bool"
    """<p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>"""
    two_way_channel_arn: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.two_way_channel_arn.TwoWayChannelArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the TwoWayChannel.</p>"""
    two_way_channel_role: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iam_role_arn.IamRoleArn"
    ]
    """<p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>"""
    self_managed_opt_outs_enabled: "bool"
    """<p>By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.</p>"""
    opt_out_list_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opt_out_list_name.OptOutListName"
    ]
    """<p>The name of the OptOutList that was associated with the phone number.</p>"""
    registration_id: NotRequired["str"]
    """<p>The unique identifier for the registration.</p>"""
    created_timestamp: NotRequired["datetime.datetime"]
    """<p>The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""

created_timestamp instance-attribute

created_timestamp: NotRequired[datetime]

The time when the phone number was created, in UNIX epoch time format.

iso_country_code instance-attribute

iso_country_code: NotRequired[IsoCountryCode]

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

message_type instance-attribute

message_type: NotRequired[MessageType]

The message type that was associated with the phone number.

monthly_leasing_price instance-attribute

monthly_leasing_price: NotRequired[str]

The monthly price of the phone number, in US dollars.

number_capabilities instance-attribute

number_capabilities: NotRequired[NumberCapabilityList]

Specifies if the number could be used for text messages, voice, or both.

number_type instance-attribute

number_type: NotRequired[NumberType]

The type of number that was released.

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListName]

The name of the OptOutList that was associated with the phone number.

phone_number instance-attribute

phone_number: NotRequired[PhoneNumber]

The phone number that was released.

phone_number_arn instance-attribute

phone_number_arn: NotRequired[str]

The PhoneNumberArn of the phone number that was released.

phone_number_id instance-attribute

phone_number_id: NotRequired[str]

The PhoneNumberId of the phone number that was released.

registration_id instance-attribute

registration_id: NotRequired[str]

The unique identifier for the registration.

self_managed_opt_outs_enabled instance-attribute

self_managed_opt_outs_enabled: bool

By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

status instance-attribute

status: NotRequired[NumberStatus]

The current status of the request.

two_way_channel_arn instance-attribute

two_way_channel_arn: NotRequired[TwoWayChannelArn]

The Amazon Resource Name (ARN) of the TwoWayChannel.

two_way_channel_role instance-attribute

two_way_channel_role: NotRequired[IamRoleArn]

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

two_way_enabled instance-attribute

two_way_enabled: bool

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.