phone-number-validate¶
Description¶
Retrieves information about a phone number.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
phone-number-validate
--number-validate-request <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--number-validate-request (structure)
Specifies a phone number to validate and retrieve information about.
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.
PhoneNumber -> (string)
The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
Shorthand Syntax:
IsoCountryCode=string,PhoneNumber=string
JSON Syntax:
{
"IsoCountryCode": "string",
"PhoneNumber": "string"
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
NumberValidateResponse -> (structure)
Provides information about a phone number.
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.
City -> (string)
The name of the city where the phone number was originally registered.
CleansedPhoneNumberE164 -> (string)
The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
CleansedPhoneNumberNational -> (string)
The cleansed phone number, in the format for the location where the phone number was originally registered.
Country -> (string)
The name of the country or region where the phone number was originally registered.
CountryCodeIso2 -> (string)
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
CountryCodeNumeric -> (string)
The numeric code for the country or region where the phone number was originally registered.
County -> (string)
The name of the county where the phone number was originally registered.
OriginalCountryCodeIso2 -> (string)
The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
OriginalPhoneNumber -> (string)
The phone number that was sent in the request body.
PhoneType -> (string)
The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
PhoneTypeCode -> (integer)
The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
Timezone -> (string)
The time zone for the location where the phone number was originally registered.
ZipCode -> (string)
The postal or ZIP code for the location where the phone number was originally registered.