Documentation

Provides information about a phone number.

See: newNumberValidateResponse smart constructor.

Create a value of NumberValidateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:carrier:NumberValidateResponse', numberValidateResponse_carrier - 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.

$sel:county:NumberValidateResponse', numberValidateResponse_county - The name of the county where the phone number was originally registered.

$sel:country:NumberValidateResponse', numberValidateResponse_country - The name of the country or region where the phone number was originally registered.

$sel:countryCodeNumeric:NumberValidateResponse', numberValidateResponse_countryCodeNumeric - The numeric code for the country or region where the phone number was originally registered.

$sel:zipCode:NumberValidateResponse', numberValidateResponse_zipCode - The postal or ZIP code for the location where the phone number was originally registered.

$sel:originalPhoneNumber:NumberValidateResponse', numberValidateResponse_originalPhoneNumber - The phone number that was sent in the request body.

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

$sel:phoneType:NumberValidateResponse', numberValidateResponse_phoneType - The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

$sel:city:NumberValidateResponse', numberValidateResponse_city - The name of the city where the phone number was originally registered.

$sel:countryCodeIso2:NumberValidateResponse', numberValidateResponse_countryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

$sel:timezone:NumberValidateResponse', numberValidateResponse_timezone - The time zone for the location where the phone number was originally registered.

$sel:originalCountryCodeIso2:NumberValidateResponse', numberValidateResponse_originalCountryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

$sel:cleansedPhoneNumberNational:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberNational - The cleansed phone number, in the format for the location where the phone number was originally registered.

$sel:cleansedPhoneNumberE164:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberE164 - The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

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.

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

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

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

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

The phone number that was sent in the request body.

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

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

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

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

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

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

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

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