Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

Проверка номера телефона

Описание

Получает информацию о номере телефона.

См. также: Документацию API AWS

Синтаксис

  phone-number-validate
--number-validate-request <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--number-validate-request (структура)

Указывает номер телефона для проверки и получения информации.

IsoCountryCode -> (строка)

Двухбуквенный код страны или региона (формат ISO 3166-1 alpha-2) по данным регистрации номера телефона.

PhoneNumber -> (строка)

Номер телефона для получения информации. Номер телефона, который вы предоставляете, должен включать корректный числовой код страны. В противном случае операция может завершиться ошибкой.

Краткая форма:

IsoCountryCode=string,PhoneNumber=string

Синтаксис JSON:

{
  "IsoCountryCode": "string",
  "PhoneNumber": "string"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, заданному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при указании yaml-input он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка в кодировке base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод пэйджера CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Более подробная информация приведена в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Получение информации о номере телефона

Следующий phone-number-validate запрос получает информацию о номере телефона.

aws pinpoint phone-number-validate \
    --number-validate-request PhoneNumber="+12065550142" \
    --region us-east-1

Вывод:

{
    "NumberValidateResponse": {
        "Carrier": "ExampleCorp Mobile",
        "City": "Seattle",
        "CleansedPhoneNumberE164": "+12065550142",
        "CleansedPhoneNumberNational": "2065550142",
        "Country": "United States",
        "CountryCodeIso2": "US",
        "CountryCodeNumeric": "1",
        "OriginalPhoneNumber": "+12065550142",
        "PhoneType": "MOBILE",
        "PhoneTypeCode": 0,
        "Timezone": "America/Los_Angeles",
        "ZipCode": "98101"
    }
}

Для получения дополнительной информации см. раздел Канал SMS Amazon Pinpoint в Руководстве пользователя Amazon Pinpoint.

Вывод

NumberValidateResponse -> (структура)

Предоставляет информацию о номере телефона.

Carrier -> (строка)

Оператор или поставщик услуг, к которому в настоящее время привязан номер телефона. В некоторых странах и регионах это может быть оператор или поставщик услуг, с которым номер телефона был первоначально зарегистрирован.

City -> (строка)

Название города, где номер телефона был первоначально зарегистрирован.

CleansedPhoneNumberE164 -> (строка)

Очищенный номер телефона в формате E.164 для местоположения, где номер телефона был первоначально зарегистрирован.

CleansedPhoneNumberNational -> (строка)

Очищенный номер телефона в формате для местоположения, где номер телефона был первоначально зарегистрирован.

Country -> (строка)

Название страны или региона, где номер телефона был первоначально зарегистрирован.

CountryCodeIso2 -> (строка)

Двухбуквенный код страны или региона (формат ISO 3166-1 alpha-2) по данным регистрации номера телефона.

CountryCodeNumeric -> (строка)

Числовой код страны или региона, где номер телефона был первоначально зарегистрирован.

County -> (строка)

Название округа, где номер телефона был первоначально зарегистрирован.

OriginalCountryCodeIso2 -> (строка)

Двухбуквенный код (формат ISO 3166-1 alpha-2), переданный в теле запроса.

OriginalPhoneNumber -> (строка)

Номер телефона, переданный в теле запроса.

PhoneType -> (строка)

Описание типа телефона. Допустимые значения: MOBILE, LANDLINE, VOIP, INVALID, PREPAID и OTHER.

PhoneTypeCode -> (целое число)

Тип телефона, представленный целым числом. Допустимые значения: 0 (мобильный), 1 (стационарный), 2 (VoIP), 3 (недействительный), 4 (другой) и 5 (предоплаченный).

Timezone -> (строка)

Часовой пояс местоположения, где номер телефона был первоначально зарегистрирован.

ZipCode -> (строка)

Почтовый или ZIP-код местоположения, где номер телефона был первоначально зарегистрирован.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API