Class: Aws::Pinpoint::Types::NumberValidateResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about a phone number.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#carrierString

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.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#cityString

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

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#cleansed_phone_number_e164String

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#cleansed_phone_number_nationalString

The cleansed phone number, in the format for the location where the phone number was originally registered.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#countryString

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

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#country_code_iso_2String

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

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#country_code_numericString

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

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#countyString

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

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#original_country_code_iso_2String

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#original_phone_numberString

The phone number that was sent in the request body.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#phone_typeString

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#phone_type_codeInteger

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

Returns:

  • (Integer)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#timezoneString

The time zone for the location where the phone number was originally registered.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end

#zip_codeString

The postal or ZIP code for the location where the phone number was originally registered.

Returns:

  • (String)


13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13717

class NumberValidateResponse < Struct.new(
  :carrier,
  :city,
  :cleansed_phone_number_e164,
  :cleansed_phone_number_national,
  :country,
  :country_code_iso_2,
  :country_code_numeric,
  :county,
  :original_country_code_iso_2,
  :original_phone_number,
  :phone_type,
  :phone_type_code,
  :timezone,
  :zip_code)
  SENSITIVE = []
  include Aws::Structure
end