Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

send-text-message

Описание

Создаёт новое текстовое сообщение и отправляет его на номер телефона получателя. SendTextMessage отправляет SMS-сообщение только одному получателю при каждом вызове.

Лимиты пропускной способности SMS измеряются в сообщениях в секунду (MPS). Ваш лимит MPS зависит от страны назначения сообщений, а также от типа номера телефона (номер отправления), который вы используете для отправки сообщения. Дополнительную информацию о MPS см. в руководстве пользователя AWS End User Messaging SMS User Guide.

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

Синтаксис

  send-text-message
--destination-phone-number <value>
[--origination-identity <value>]
[--message-body <value>]
[--message-type <value>]
[--keyword <value>]
[--configuration-set-name <value>]
[--max-price <value>]
[--time-to-live <value>]
[--context <value>]
[--destination-country-parameters <value>]
[--dry-run | --no-dry-run]
[--protect-configuration-id <value>]
[--message-feedback-enabled | --no-message-feedback-enabled]
[--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]

Параметры

--destination-phone-number (строка)

Номер телефона получателя в формате E.164.

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

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

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

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

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

Текст сообщения.

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

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

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

  • TRANSACTIONAL
  • PROMOTIONAL

--keyword (строка)

При регистрации короткого кода в США, необходимо указать имя программы. Если у вас нет короткого кода США, опустите этот атрибут.

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

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

--max-price (строка)

Максимальная сумма, которую вы хотите потратить в долларах США на каждое SMS-сообщение. Если рассчитанная сумма для отправки SMS-сообщения превышает MaxPrice, сообщение не будет отправлено, и будет возвращена ошибка.

--time-to-live (целое число)

Срок действия SMS-сообщения в секундах. По умолчанию 72 часа. Если сообщение не передано до истечения срока действия, попытки передачи прекращаются, и возвращается событие TTL_EXPIRED.

--context (массив)

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

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

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

Синтаксис сокращённого вида:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

  • IN_ENTITY_ID Идентификатор сущности или идентификатор основной сущности (PE), полученный после завершения процесса регистрации идентификатора отправителя.
  • IN_TEMPLATE_ID Идентификатор шаблона, полученный после завершения процесса регистрации идентификатора отправителя.

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

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

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

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

Синтаксис сокращённого вида:

  KeyName1=string,KeyName2=string

Where valid key names are:
  IN_TEMPLATE_ID
  IN_ENTITY_ID

Синтаксис JSON:

{"IN_TEMPLATE_ID"|"IN_ENTITY_ID": "string"
  ...}

--dry-run | --no-dry-run (логическое значение)

При установке в значение true сообщение проверяется и валидируется, но не отправляется конечному получателю. Вы не оплачиваете использование DryRun.

Лимит сообщений в секунду (MPS) при использовании DryRun составляет пять. Если у вашего идентификатора отправителя меньше лимит MPS, используется меньшее значение MPS. Дополнительную информацию о лимитах MPS см. в разделе Ограничения MPS в руководстве пользователя AWS End User Messaging SMS User Guide.

--protect-configuration-id (строка)

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

--message-feedback-enabled | --no-message-feedback-enabled (логическое значение)

Установите в значение true, чтобы включить обратную связь по сообщению. Когда пользователь получает сообщение, необходимо обновить статус сообщения с помощью PutMessageFeedback.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок 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