Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

request-phone-number

Описание

Запросить номер телефона исходящей линии для использования в вашей учетной записи. Дополнительную информацию о запросе номера телефона см. в руководстве пользователя AWS End User Messaging SMS, раздел «Запрос номера телефона».

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

Синтаксис

  request-phone-number
--iso-country-code <value>
--message-type <value>
--number-capabilities <value>
--number-type <value>
[--opt-out-list-name <value>]
[--pool-id <value>]
[--registration-id <value>]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--tags <value>]
[--client-token <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]

Параметры

--iso-country-code (строка)

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

--message-type (строка)

Тип сообщения. Допустимые значения: TRANSACTIONAL для критически важных или срочных сообщений и PROMOTIONAL для сообщений, не являющихся критически важными или срочными.

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

  • TRANSACTIONAL
  • PROMOTIONAL

--number-capabilities (список)

Указывает, будет ли номер телефона использоваться для текстовых сообщений, голосовых сообщений или обоих типов.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SMS
  VOICE
  MMS

--number-type (строка)

Тип запрашиваемого номера телефона.

При запросе SIMULATOR номера телефона, необходимо установить MessageType как TRANSACTIONAL .

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

  • LONG_CODE
  • TOLL_FREE
  • TEN_DLC
  • SIMULATOR

--opt-out-list-name (строка)

Имя OptOutList для ассоциации с номером телефона. Можно использовать OptOutListName или OptOutListArn.

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

Если вы используете общие ресурсы AWS End User Messaging SMS и Voice, то необходимо использовать полное Amazon Resource Name (ARN).

--pool-id (строка)

Пул для ассоциации с номером телефона. Можно использовать PoolId или PoolArn.

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

Если вы используете общие ресурсы AWS End User Messaging SMS и Voice, то необходимо использовать полное Amazon Resource Name (ARN).

--registration-id (строка)

Используйте это поле для прикрепления вашего номера телефона для внешнего процесса регистрации.

--deletion-protection-enabled | --no-deletion-protection-enabled (булево)

По умолчанию установлено в false. При установке в true номер телефона не может быть удален.

--tags (список)

Массив тегов (пар ключ-значение) для ассоциации с запрашиваемым номером телефона.

(структура)

Список тегов, которые необходимо добавить к указанной теме.

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

Идентификатор или имя ключа тега.

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

Строковое значение, связанное с ключом тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Если вы не укажете client token, для обеспечения идемпотентности запроса используется случайный генерируемый токен.

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

PhoneNumberArn -> (строка)

Amazon Resource Name (ARN) запрошенного номера телефона.

PhoneNumberId -> (строка)

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

PhoneNumber -> (строка)

Новый запрашиваемый номер телефона.

Status -> (строка)

Текущий статус запроса.

IsoCountryCode -> (строка)

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

MessageType -> (строка)

Тип сообщения. Допустимые значения TRANSACTIONAL для критически важных или срочных сообщений и PROMOTIONAL для сообщений, не являющихся критически важными или срочными.

NumberCapabilities -> (список)

Указывает, будет ли номер телефона использоваться для текстовых сообщений, голосовых сообщений или обоих типов.

(строка)

NumberType -> (строка)

Тип выпущенного номера.

MonthlyLeasingPrice -> (строка)

Ежемесячная цена в долларах США за аренду номера телефона.

TwoWayEnabled -> (булево)

По умолчанию установлено в false. При установке в true можно получать входящие текстовые сообщения от ваших конечных получателей.

TwoWayChannelArn -> (строка)

ARN, используемый для идентификации двухстороннего канала.

TwoWayChannelRole -> (строка)

Необязательный IAM Role Arn для сервиса, который должен получить доступ, чтобы иметь возможность отправлять входящие SMS-сообщения.

SelfManagedOptOutsEnabled -> (булево)

По умолчанию установлено в false. Когда конечный получатель отправляет сообщение, начинающееся с HELP или STOP, одному из ваших выделенных номеров, AWS End User Messaging SMS и Voice автоматически отвечает настраиваемым сообщением и добавляет конечного получателя в список OptOutList. При установке в true вы несете ответственность за ответы на запросы HELP и STOP. Вы также несете ответственность за отслеживание и выполнение запросов об отказе от подписки.

OptOutListName -> (строка)

Имя OptOutList, которое связано с запрашиваемым номером телефона.

DeletionProtectionEnabled -> (булево)

По умолчанию установлено в false. При установке в true номер телефона не может быть удален.

PoolId -> (строка)

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

RegistrationId -> (строка)

Уникальный идентификатор регистрации.

Tags -> (список)

Массив пар ключ-значение тегов, которые связаны с номером телефона.

(структура)

Список тегов, которые необходимо добавить к указанной теме.

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

Идентификатор или имя ключа тега.

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

Строковое значение, связанное с ключом тега.

CreatedTimestamp -> (временная метка)

Время создания номера телефона в формате временной метки UNIX.

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

Spec-Zone.ru

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