CarrierLookupResult ¶

class CarrierLookupResult(TypedDict, closed=True):
    e164_phone_number: (
        "capo_pinpoint_sms_voice_v2.types.e164_phone_number_type.E164PhoneNumberType"
    )
    """<p>The phone number in E164 format, sanitized from the original input by removing any formatting characters.</p>"""
    dialing_country_code: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.dialing_country_code_type.DialingCountryCodeType"
    ]
    """<p>The country or region numeric dialing code for the phone number.</p>"""
    iso_country_code: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode"
    ]
    """<p>The two-character country or region code, in ISO 3166-1 alpha-2 format, for the phone number.</p>"""
    country: NotRequired["str"]
    """<p>The name of the country or region for the phone number.</p>"""
    mcc: NotRequired["capo_pinpoint_sms_voice_v2.types.mcc_type.MCCType"]
    """<p>The phone number's mobile country code, for mobile phone number types</p>"""
    mnc: NotRequired["capo_pinpoint_sms_voice_v2.types.mnc_type.MNCType"]
    """<p>The phone number's mobile network code, for mobile phone number types.</p>"""
    carrier: NotRequired["str"]
    """<p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>"""
    phone_number_type: (
        "capo_pinpoint_sms_voice_v2.types.phone_number_type.PhoneNumberType"
    )
    """<p>Describes the type of phone number. Valid values are: MOBILE, LANDLINE, VOIP, PREPAID, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.</p>"""
    original_phone_number: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.carrier_lookup_input_phone_number_type.CarrierLookupInputPhoneNumberType"
    ]
    """<p>The phone number exactly as you supplied it in the request. This field is returned only when you set <code>EnableCleansing</code> to <code>true</code>, the phone number was cleansed, and a normalized E.164 phone number was returned in the <code>E164PhoneNumber</code> field.</p>"""