Skip to content

PhoneNumber

Source code in docs_src/capo_chime_sdk_voice/types/phone_number.py
class PhoneNumber(TypedDict, closed=True):
    phone_number_id: NotRequired[
        "capo_chime_sdk_voice.types.sensitive_non_empty_string.SensitiveNonEmptyString"
    ]
    """<p>The phone number's ID.</p>"""
    e164_phone_number: NotRequired[
        "capo_chime_sdk_voice.types.e164_phone_number.E164PhoneNumber"
    ]
    """<p>The phone number, in E.164 format.</p>"""
    phone_number_arn: NotRequired[
        "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString"
    ]
    country: NotRequired[
        "capo_chime_sdk_voice.types.alpha2_country_code.Alpha2CountryCode"
    ]
    """<p>The phone number's country. Format: ISO 3166-1 alpha-2.</p>"""
    type: NotRequired["capo_chime_sdk_voice.types.phone_number_type.PhoneNumberType"]
    """<p>The phone number's type.</p>"""
    product_type: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_product_type.PhoneNumberProductType"
    ]
    """<p>The phone number's product type.</p>"""
    status: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_status.PhoneNumberStatus"
    ]
    """<p>The phone number's status.</p>"""
    capabilities: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_capabilities.PhoneNumberCapabilities"
    ]
    """<p>The phone number's capabilities.</p>"""
    associations: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_association_list.PhoneNumberAssociationList"
    ]
    """<p>The phone number's associations.</p>"""
    calling_name: NotRequired["capo_chime_sdk_voice.types.calling_name.CallingName"]
    """<p>The outbound calling name associated with the phone number.</p>"""
    calling_name_status: NotRequired[
        "capo_chime_sdk_voice.types.calling_name_status.CallingNameStatus"
    ]
    """<p>The outbound calling name status.</p>"""
    created_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The phone number creation timestamp, in ISO 8601 format.</p>"""
    updated_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The updated phone number timestamp, in ISO 8601 format.</p>"""
    deletion_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The deleted phone number timestamp, in ISO 8601 format.</p>"""
    order_id: NotRequired["capo_chime_sdk_voice.types.guid_string.GuidString"]
    """<p>The phone number's order ID.</p>"""
    name: NotRequired["capo_chime_sdk_voice.types.phone_number_name.PhoneNumberName"]
    """<p>The name of the phone number.</p>"""

associations instance-attribute

associations: NotRequired[PhoneNumberAssociationList]

The phone number's associations.

calling_name instance-attribute

calling_name: NotRequired[CallingName]

The outbound calling name associated with the phone number.

calling_name_status instance-attribute

calling_name_status: NotRequired[CallingNameStatus]

The outbound calling name status.

capabilities instance-attribute

capabilities: NotRequired[PhoneNumberCapabilities]

The phone number's capabilities.

country instance-attribute

country: NotRequired[Alpha2CountryCode]

The phone number's country. Format: ISO 3166-1 alpha-2.

created_timestamp instance-attribute

created_timestamp: NotRequired[Iso8601Timestamp]

The phone number creation timestamp, in ISO 8601 format.

deletion_timestamp instance-attribute

deletion_timestamp: NotRequired[Iso8601Timestamp]

The deleted phone number timestamp, in ISO 8601 format.

e164_phone_number instance-attribute

e164_phone_number: NotRequired[E164PhoneNumber]

The phone number, in E.164 format.

name instance-attribute

name: NotRequired[PhoneNumberName]

The name of the phone number.

order_id instance-attribute

order_id: NotRequired[GuidString]

The phone number's order ID.

phone_number_arn instance-attribute

phone_number_arn: NotRequired[NonEmptyString]

phone_number_id instance-attribute

phone_number_id: NotRequired[SensitiveNonEmptyString]

The phone number's ID.

product_type instance-attribute

product_type: NotRequired[PhoneNumberProductType]

The phone number's product type.

status instance-attribute

status: NotRequired[PhoneNumberStatus]

The phone number's status.

type instance-attribute

type: NotRequired[PhoneNumberType]

The phone number's type.

updated_timestamp instance-attribute

updated_timestamp: NotRequired[Iso8601Timestamp]

The updated phone number timestamp, in ISO 8601 format.