Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

send-destination-number-verification-code

Описание

Прежде чем отправлять тестовые сообщения на проверенный номер телефона получателя, необходимо включить этот номер. Создаёт новое текстовое сообщение с кодом подтверждения и отправляет его на проверенный номер телефона получателя. После получения кода подтверждения используйте VerifyDestinationNumber, чтобы включить проверенный номер телефона получателя для получения сообщений.

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

Синтаксис

  send-destination-number-verification-code
--verified-destination-number-id <value>
--verification-channel <value>
[--language-code <value>]
[--origination-identity <value>]
[--configuration-set-name <value>]
[--context <value>]
[--destination-country-parameters <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]

Параметры

--verified-destination-number-id (строка)

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

--verification-channel (строка)

Выберите, отправлять ли код подтверждения в виде SMS или голосового сообщения.

Возможные значения:

  • TEXT
  • VOICE

--language-code (строка)

Выберите язык для сообщения.

Возможные значения:

  • DE_DE
  • EN_GB
  • EN_US
  • ES_419
  • ES_ES
  • FR_CA
  • FR_FR
  • IT_IT
  • JA_JP
  • KO_KR
  • PT_BR
  • ZH_CN
  • ZH_TW

--origination-identity (строка)

Идентификатор отправителя сообщения. Это может быть PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId или PoolArn.

Предупреждение

Если вы используете общий ресурс AWS для отправки SMS и голосовых сообщений пользователям, то необходимо использовать полное Amazon Resource Name (ARN).

--configuration-set-name (строка)

Имя набора конфигураций для использования. Это может быть ConfigurationSetName или ConfigurationSetArn.

--context (массив)

Вы можете указать пользовательские данные в этом поле. Если вы это сделаете, эти данные будут записаны в пункт назначения события.

ключ -> (строка)

значение -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--destination-country-parameters (массив)

Это поле используется для любых требований регистрации, специфичных для страны. В настоящее время этот параметр используется только при отправке сообщений получателям в Индии с использованием идентификатора отправителя. Для получения дополнительной информации см. Специальные требования к отправке SMS-сообщений получателям в Индии.

ключ -> (строка)

значение -> (строка)

Сокращённый синтаксис:

  KeyName1=string,KeyName2=string

Where valid key names are:
  IN_TEMPLATE_ID
  IN_ENTITY_ID

Синтаксис JSON:

{"IN_TEMPLATE_ID"|"IN_ENTITY_ID": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать конкретный профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

MessageId -> (строка)

Уникальный идентификатор сообщения.

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

Spec-Zone.ru

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