Amazon Pinpoint SMS Voice V2

Returns information about a destination phone number, including whether the number type and whether it is valid, the carrier, and more.

See also: AWS API Documentation

Request Syntax

client.carrier_lookup(
    PhoneNumber='string'
)

type PhoneNumber:

string

param PhoneNumber:

[REQUIRED]

The phone number that you want to retrieve information about. You can provide the phone number in various formats including special characters such as parentheses, brackets, spaces, hyphens, periods, and commas. The service automatically converts the input to E164 format for processing.

rtype:

dict

returns:

Response Syntax

{
    'E164PhoneNumber': 'string',
    'DialingCountryCode': 'string',
    'IsoCountryCode': 'string',
    'Country': 'string',
    'MCC': 'string',
    'MNC': 'string',
    'Carrier': 'string',
    'PhoneNumberType': 'MOBILE'|'LANDLINE'|'OTHER'|'INVALID'
}

Response Structure

• (dict) --

  • E164PhoneNumber (string) --

    The phone number in E164 format, sanitized from the original input by removing any formatting characters.

  • DialingCountryCode (string) --

    The numeric dialing code for the country or region where the phone number was originally registered.

  • IsoCountryCode (string) --

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

  • Country (string) --

    The name of the country where the phone number was originally registered.

  • MCC (string) --

    The phone number's mobile country code, for mobile phone number types

  • MNC (string) --

    The phone number's mobile network code, for mobile phone number types.

  • Carrier (string) --

    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.

  • PhoneNumberType (string) --

    Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.