Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

Отправка сообщений пользователям

Описание

Создает и отправляет сообщение списку пользователей.

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

Синтаксис

  send-users-messages
--application-id <value>
--send-users-message-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]

Параметры

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

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта в консоли Amazon Pinpoint.

--send-users-message-request (структура)

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

Context -> (массив)

Массив пользовательских пар атрибут-значение. Для push-уведомления Amazon Pinpoint добавляет эти атрибуты в объект data.pinpoint в теле уведомления. Amazon Pinpoint также предоставляет эти атрибуты в событиях, которые он генерирует для доставки сообщений пользователям.

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

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

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

Настройки и содержимое стандартного сообщения и любых стандартных сообщений, определенных для конкретных каналов.

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

Стандартное push-уведомление для канала ADM (Amazon Device Messaging). Это сообщение переопределяет стандартное push-уведомление (DefaultPushNotificationMessage).

Action -> (строка)

Действие, которое должно произойти при нажатии получателем на push-уведомление. Допустимые значения:

  • OPEN_APP - Ваше приложение открывается или становится фоновым приложением, если оно было отправлено в фоновый режим. Это действие по умолчанию.
  • DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Это действие использует возможности глубокой линковки платформы Android.
  • URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному вами URL.

Body -> (строка)

Тело сообщения уведомления.

ConsolidationKey -> (строка)

Произвольная строка, указывающая, что несколько сообщений логически идентичны и что Amazon Device Messaging (ADM) может отбрасывать ранее поставленные в очередь сообщения в пользу этого сообщения.

Data -> (массив)

JSON-данные, которые необходимо использовать для push-уведомления, если уведомление является тихим push-уведомлением. Эти данные добавляются к объекту data.pinpoint.jsonBody уведомления.

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

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

ExpiresAfter -> (строка)

Время в секундах, которое ADM должен хранить сообщение, если устройство получателя находится в автономном режиме. Amazon Pinpoint указывает это значение в параметре expiresAfter при отправке сообщения уведомления в ADM.

IconReference -> (строка)

Имя изображения значка актива, сохранённого в вашем приложении.

ImageIconUrl -> (строка)

URL большого изображения значка для отображения в представлении содержимого push-уведомления.

ImageUrl -> (строка)

URL изображения для отображения в push-уведомлении.

MD5 -> (строка)

Базовое64-кодированное значение контрольной суммы MD5 значения, указанного в свойстве Data. ADM использует значение MD5 для проверки целостности данных.

RawContent -> (строка)

Необработанная JSON-строка, которую следует использовать в качестве полезной нагрузки для сообщения уведомления. При указании это значение переопределяет всё остальное содержимое сообщения.

SilentPush -> (булево)

Указывает, является ли уведомление тихим push-уведомлением, которое не отображается на устройстве получателя. Тихие push-уведомления могут использоваться для таких задач, как обновление конфигурации приложения или поддержка функции «обратная связь».

SmallImageIconUrl -> (строка)

URL малого изображения значка для отображения в строке состояния и в представлении содержимого push-уведомления.

Sound -> (строка)

Звук, который должен воспроизводиться при получении получателем push-уведомления. Вы можете использовать стандартный поток или указать имя файла звукового ресурса, который включён в ваше приложение. В платформе Android файл звука должен находиться в каталоге /res/raw/.

Substitutions -> (массив)

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

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

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

(строка)

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

URL для открытия в стандартном мобильном браузере получателя, если получатель нажимает на push-уведомление, а значение свойства Action равно URL.

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

Значение сообщения по умолчанию для push-уведомлений канала APNs (служба Apple Push Notification). Это сообщение переопределяет значение сообщения по умолчанию (DefaultPushNotificationMessage).

APNSPushType -> (строка)

Тип отправляемого push-уведомления. Допустимые значения:

  • alert - Для стандартного уведомления, отображаемого на устройствах получателей, которое побуждает получателя взаимодействовать с уведомлением.
  • background - Для беззвучного уведомления, которое доставляет содержимое на заднем плане и не отображается на устройствах получателей.
  • complication - Для уведомления, содержащего обновленную информацию для временной шкалы осложнений приложения.
  • fileprovider - Для уведомления, сигнализирующего о изменениях в расширении поставщика файлов.
  • mdm - Для уведомления, которое сообщает управляемым устройствам о необходимости связаться с сервером MDM.
  • voip - Для уведомления, содержащего информацию об входящем VoIP-звонке.

Amazon Pinpoint указывает это значение в заголовке запроса apns-push-type при отправке сообщения уведомления в APNs. Если вы не укажете значение для этого свойства, Amazon Pinpoint автоматически установит значение alert или background, в зависимости от значения, указанного вами для свойства SilentPush или RawContent сообщения.

Дополнительную информацию о заголовке запроса apns-push-type см. на веб-сайте Apple Developer в разделе «Отправка запросов уведомлений в APNs».

Action -> (строка)

Действие, которое должно произойти, если получатель нажмет на push-уведомление. Допустимые значения:

  • OPEN_APP - Ваше приложение открывается или переходит в фоновый режим, если оно было отправлено в фоновый режим. Это действие по умолчанию.
  • DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Этот параметр использует возможности глубокой ссылки платформы iOS.
  • URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному вами URL.

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

Ключ, указывающий, следует ли и как изменить значок приложения, когда получатель получает push-уведомление. Если этот ключ не включён в словарь, значок не изменяется. Чтобы удалить значок, установите это значение в 0.

Body -> (строка)

Тело сообщения уведомления.

Category -> (строка)

Ключ, указывающий тип уведомления для push-уведомления. Этот ключ — значение, определённое свойством identifier одной из зарегистрированных категорий вашего приложения.

CollapseId -> (строка)

Произвольный идентификатор, который, если присваивается нескольким сообщениям, APNs использует для объединения сообщений в одно push-уведомление вместо отдельной доставки каждого сообщения. Это значение не может превышать 64 байта.

Amazon Pinpoint указывает это значение в заголовке запроса apns-collapse-id при отправке сообщения уведомления в APNs.

Data -> (массив)

JSON-данные для использования в беззвучном push-уведомлении. Эти данные добавляются в объект data.pinpoint.jsonBody уведомления.

key -> (строка)

value -> (строка)

MediaUrl -> (строка)

URL изображения или видео для отображения в push-уведомлении.

PreferredAuthenticationMethod -> (строка)

Метод аутентификации, который вы хотите использовать Amazon Pinpoint для аутентификации с APNs, CERTIFICATE или TOKEN.

Priority -> (строка)

para>5 - Низкий приоритет, уведомление может быть задерживается, доставлено в группе или ограничено.

/listitem> * 10 - Высокий приоритет, уведомление отправляется немедленно. Это значение по умолчанию. Уведомление с высоким приоритетом должно вызывать всплывающее окно, воспроизводить звук или устанавливать значок приложения на устройстве получателя. /para>

Amazon Pinpoint указывает это значение в заголовке запроса apns-priority при отправке сообщения уведомления в APNs.

Эквивалентные значения для Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM), — normal для 5 и high для 10. Если вы укажете значение FCM для этого свойства, Amazon Pinpoint примет и преобразует значение в соответствующее значение APNs.

RawContent -> (строка)

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

Примечание

Если вы указываете сырое содержимое push-уведомления APNs, полезная нагрузка сообщения должна включать ключ content-available. Значение ключа content-available должно быть целым числом и может быть только 0 или 1. Если вы отправляете стандартное уведомление, установите значение content-available в 0. Если вы отправляете беззвучное (фоновое) уведомление, установите значение content-available в 1. Кроме того, полезные нагрузки беззвучных уведомлений не могут содержать ключи alert, badge или sound. Дополнительную информацию см. на веб-сайте Apple Developer в разделе «Создание удалённого уведомления и отправка обновлений фонового приложения».

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

Указывает, является ли уведомление беззвучным push-уведомлением. Беззвучное (или фоновое) push-уведомление не отображается на устройствах получателей. Вы можете использовать беззвучные push-уведомления для небольших обновлений приложения или для отображения сообщений в центре сообщений приложения.

Amazon Pinpoint использует это свойство для определения правильного значения для заголовка запроса apns-push-type при отправке сообщения уведомления в APNs. Если вы укажете значение true для этого свойства, Amazon Pinpoint установит значение для поля заголовка apns-push-type в background.

Примечание

Если вы указываете сырое содержимое push-уведомления APNs, полезная нагрузка сообщения должна включать ключ content-available. Для беззвучных (фоновых) уведомлений установите значение content-available в 1. Кроме того, полезная нагрузка сообщения для беззвучного уведомления не может содержать ключи alert, badge или sound. Дополнительную информацию см. на веб-сайте Apple Developer в разделе «Создание удалённого уведомления и отправка обновлений фонового приложения».

Apple указал, что они будут ограничивать «чрезмерные» фоновые уведомления, основываясь на текущем объёме трафика. Чтобы предотвратить ограничение ваших уведомлений, Apple рекомендует отправлять не более 3 беззвучных push-уведомлений каждому получателю в час.

Sound -> (строка)

Ключ для воспроизведения звука, когда получатель получает push-уведомление. Значение этого ключа — имя файла звука в главном пакете вашего приложения или в папке Library/Sounds в контейнере данных вашего приложения. Если файл звука не найден или вы указали значение default, система воспроизводит стандартный звук уведомления.

Substitutions -> (массив)

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

key -> (строка)

value -> (список)

(строка)

ThreadId -> (строка)

Ключ, представляющий ваш идентификатор для группировки уведомлений. Если вы предоставили расширение приложения Notification Content, вы можете использовать это значение для группировки уведомлений.

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

Время в секундах, в течение которого APNs должно хранить и пытаться доставить push-уведомление, если служба не смогла доставить уведомление с первого раза. Если это значение равно 0, APNs обрабатывает уведомление как немедленно истекающее, и служба не хранит и не пытается доставить уведомление снова.

Amazon Pinpoint указывает это значение в заголовке запроса apns-expiration при отправке сообщения уведомления в APNs.

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

URL для открытия в стандартном мобильном браузере получателя, если получатель нажимает на push-уведомление, и значение свойства Action равно URL.

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

Значение сообщения по умолчанию для push-уведомлений канала Baidu (Baidu Cloud Push). Это сообщение переопределяет значение сообщения по умолчанию (DefaultPushNotificationMessage).

Action -> (строка)

Действие, которое должно произойти, если получатель нажмёт на push-уведомление. Допустимые значения:

  • OPEN_APP - Ваше приложение открывается или переходит в фоновый режим, если оно было отправлено в фоновый режим. Это действие по умолчанию.
  • DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Это действие использует возможности глубокой ссылки платформы Android.
  • URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному вами URL.

Body -> (строка)

Тело сообщения уведомления.

Data -> (массив)

JSON-данные для использования в качестве полезной нагрузки push-уведомления, если уведомление — беззвучное push-уведомление. Эти данные добавляются в объект data.pinpoint.jsonBody уведомления.

key -> (строка)

value -> (строка)

IconReference -> (строка)

Имя изображения значка, сохранённого в вашем приложении.

ImageIconUrl -> (строка)

URL большого изображения значка для отображения в представлении содержимого push-уведомления.

ImageUrl -> (строка)

URL изображения для отображения в push-уведомлении.

RawContent -> (строка)

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

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

Указывает, является ли уведомление беззвучным push-уведомлением, которое не отображается на устройстве получателя. Беззвучные push-уведомления могут использоваться для обновлений конфигурации приложения или поддержки функциональности «телефонный домой».

SmallImageIconUrl -> (строка)

URL малого изображения значка для отображения в строке состояния и представлении содержимого push-уведомления.

Sound -> (строка)

Звук, который воспроизводится, когда получатель получает push-уведомление. Можно использовать стандартный поток или указать имя файла ресурса звука, включённого в ваше приложение. На платформе Android файл звука должен находиться в каталоге /res/raw/.

Substitutions -> (массив)

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

key -> (строка)

value -> (список)

(строка)

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

Время в секундах, в течение которого служба Baidu Cloud Push должна хранить сообщение, если устройство получателя находится в автономном режиме. Значение по умолчанию и максимальное поддерживаемое время — 604 800 секунд (7 дней).

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

URL для открытия в стандартном мобильном браузере получателя, если получатель нажимает на push-уведомление, и значение свойства Action равно URL.

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

Стандартное сообщение для всех каналов.

Body -> (string)

Стандартное тело сообщения.

Substitutions -> (map)

Стандартные переменные сообщения, используемые в сообщении. Вы можете переопределить эти стандартные переменные индивидуальными переменными адреса.

key -> (string)

value -> (list)

(string)

DefaultPushNotificationMessage -> (structure)

Стандартное сообщение push-уведомления для всех каналов push-уведомлений.

Action -> (string)

Стандартное действие, которое должно произойти, если получатель нажмёт на push-уведомление. Допустимые значения:

  • OPEN_APP - Ваше приложение откроется или перейдёт в фоновый режим, если оно было отправлено в фоновый режим. Это стандартное действие.
  • DEEP_LINK - Ваше приложение откроется и отобразит заданный пользовательский интерфейс в приложении. Этот параметр использует возможности глубокой ссылки платформ iOS и Android.
  • URL - Стандартный мобильный браузер устройства получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (string)

Стандартное тело сообщения уведомления.

Data -> (map)

JSON-данные полезной нагрузки для стандартного push-уведомления, если уведомление является тихим push-уведомлением. Эта полезная нагрузка добавляется к объекту data.pinpoint.jsonBody уведомления.

key -> (string)

value -> (string)

SilentPush -> (boolean)

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

Substitutions -> (map)

Стандартные переменные сообщения, используемые в сообщении уведомления. Вы можете переопределить стандартные переменные индивидуальными переменными адреса.

key -> (string)

value -> (list)

(string)

Title -> (string)

Стандартное заголовок, отображаемое над сообщением уведомления на устройстве получателя.

Url -> (string)

Стандартный URL для открытия в стандартном мобильном браузере получателя, если получатель нажмёт на push-уведомление, а значение свойства Action равно URL.

EmailMessage -> (structure)

Стандартное сообщение для канала электронной почты. Это сообщение переопределяет стандартное сообщение (DefaultMessage).

Body -> (string)

Тело сообщения электронной почты.

FeedbackForwardingAddress -> (string)

Адрес электронной почты для перенаправления возвратов и жалоб, если включена переадресация обратной связи.

FromAddress -> (string)

Подтверждённый адрес электронной почты для отправки сообщения электронной почты. Значение по умолчанию — FromAddress, указанный для канала электронной почты.

RawEmail -> (structure)

Сообщение электронной почты, представленное как сырое MIME-сообщение.

Data -> (blob)

Сообщение электронной почты, представленное как сырое MIME-сообщение. Всё сообщение должно быть закодировано в base64.

ReplyToAddresses -> (list)

Адрес(а) ответа для сообщения электронной почты. Если получатель ответит на электронное письмо, каждое адрес ответа получит ответ.

(string)

SimpleEmail -> (structure)

Сообщение электронной почты, составленное из темы, текстовой части и HTML-части.

HtmlPart -> (structure)

Тело сообщения электронной почты в формате HTML. Рекомендуется использовать формат HTML для клиентов электронной почты, которые отображают содержимое HTML. Вы можете включать ссылки, форматированный текст и многое другое в сообщение HTML.

Charset -> (string)

Применимый набор символов для содержимого сообщения.

Data -> (string)

Текстовые данные содержимого сообщения.

Subject -> (structure)

Строка темы или заголовок электронного письма.

Charset -> (string)

Применимый набор символов для содержимого сообщения.

Data -> (string)

Текстовые данные содержимого сообщения.

TextPart -> (structure)

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

Charset -> (string)

Применимый набор символов для содержимого сообщения.

Data -> (string)

Текстовые данные содержимого сообщения.

Headers -> (list)

Список MessageHeaders для электронного письма. Вы можете иметь до 15 заголовков.

(structure)

Содержит пару имя-значение заголовка электронного письма для добавления в электронное письмо. Вы можете иметь до 15 MessageHeaders. Заголовок может содержать информацию, такую как отправитель, получатель, маршрут или метка времени.

Name -> (string)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (string)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину любых рендерных атрибутов. Например, если вы добавите атрибут {CreationDate}, он отобразится как YYYY-MM-DDTHH:MM:SS.SSSZ и имеет длину 24 символа.

Substitutions -> (map)

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

key -> (string)

value -> (list)

(string)

GCMMessage -> (structure)

Стандартное сообщение push-уведомления для канала GCM, которое используется для отправки уведомлений через службу Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Это сообщение переопределяет стандартное сообщение push-уведомления (DefaultPushNotificationMessage).

Action -> (string)

Действие, которое должно произойти, если получатель нажмёт на push-уведомление. Допустимые значения:

  • OPEN_APP - Ваше приложение откроется или перейдёт в фоновый режим, если оно было отправлено в фоновый режим. Это стандартное действие.
  • DEEP_LINK - Ваше приложение откроется и отобразит заданный пользовательский интерфейс в приложении. Это действие использует возможности глубокой ссылки платформы Android.
  • URL - Стандартный мобильный браузер устройства получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (string)

Тело сообщения уведомления.

CollapseKey -> (string)

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

Amazon Pinpoint указывает это значение в параметре collapse_key Firebase Cloud Messaging (FCM) при отправке сообщения уведомления в FCM.

Data -> (map)

JSON-данные полезной нагрузки для push-уведомления, если уведомление является тихим push-уведомлением. Эта полезная нагрузка добавляется к объекту data.pinpoint.jsonBody уведомления.

key -> (string)

value -> (string)

IconReference -> (string)

Имя изображения значка ресурса, сохранённого в вашем приложении.

ImageIconUrl -> (string)

URL изображения большого значка, который отображается в области содержимого push-уведомления.

ImageUrl -> (string)

URL изображения для отображения в push-уведомлении.

PreferredAuthenticationMethod -> (string)

Предпочтительный метод аутентификации, со значениями «KEY» или «TOKEN». Если значение не указано, используется значение по умолчанию DefaultAuthenticationMethod.

Priority -> (string)

para>normal – Уведомление может быть задерживается. Доставка оптимизирована для экономии заряда батареи на устройстве получателя. Используйте это значение, если не требуется немедленная доставка.

/listitem> * high – Уведомление отправляется немедленно и может разбудить спящее устройство. /para>

Amazon Pinpoint указывает это значение в параметре priority FCM при отправке сообщения уведомления в FCM.

Эквивалентные значения для Apple Push Notification service (APNs) — 5 для нормального и 10 для высокого. Если вы укажете значение APNs для этого свойства, Amazon Pinpoint примет и преобразует значение в соответствующее значение FCM.

RawContent -> (string)

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

RestrictedPackageName -> (string)

Имя пакета приложения, в котором токены регистрации должны совпадать для получения получателем сообщения.

SilentPush -> (boolean)

Указывает, является ли уведомление тихим push-уведомлением, которое не отображается на устройстве получателя. Тихие push-уведомления могут использоваться для случаев, таких как обновление конфигурации приложения или поддержка функциональности «обратная связь».

SmallImageIconUrl -> (string)

URL изображения малого значка, отображаемого в строке состояния и области содержимого push-уведомления.

Sound -> (string)

Звук, воспроизводимый при получении получателем push-уведомления. Вы можете использовать стандартный поток или указать имя файла звукового ресурса, включенного в ваше приложение. На платформе Android файл звука должен находиться в /res/raw/.

Substitutions -> (map)

Стандартные переменные сообщения для использования в сообщении уведомления. Вы можете переопределить стандартные переменные индивидуальными переменными адреса.

key -> (string)

value -> (list)

(string)

TimeToLive -> (integer)

Время в секундах, в течение которого FCM должен хранить и пытаться доставить push-уведомление, если служба не может доставить уведомление с первого раза. Если вы не укажете это значение, FCM по умолчанию использует максимальное значение, которое составляет 2 419 200 секунд (28 дней).

Amazon Pinpoint указывает это значение в параметре time_to_live FCM при отправке сообщения уведомления в FCM.

Title -> (string)

Заголовок, отображаемый над сообщением уведомления на устройстве получателя.

Url -> (string)

URL для открытия в стандартном мобильном браузере получателя, если получатель нажмёт на push-уведомление, а значение свойства Action равно URL.

SMSMessage -> (structure)

Значение сообщения по умолчанию для канала SMS. Это сообщение переопределяет значение сообщения по умолчанию (DefaultMessage).

Body -> (строка)

Тело сообщения SMS.

Keyword -> (строка)

Название программы SMS, предоставленное вами в AWS Support при запросе выделенного номера.

MediaUrl -> (строка)

Это поле зарезервировано для использования в будущем.

MessageType -> (строка)

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

OriginationNumber -> (строка)

Номер, с которого отправляется сообщение SMS. Это значение должно быть одним из выделенных длинных или коротких кодов, назначенных вашей учетной записи AWS. Если вы не укажете длинный или короткий код, Amazon Pinpoint назначит сообщению SMS случайный длинный код и отправит сообщение с этого кода.

SenderId -> (строка)

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

Substitutions -> (отображение)

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

key -> (строка)

value -> (список)

(строка)

EntityId -> (строка)

Идентификатор сущности или идентификатор основной сущности (PE), полученный от регулирующего органа для отправки SMS в вашей стране.

TemplateId -> (строка)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

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

Значение сообщения по умолчанию для голосового канала. Это сообщение переопределяет значение сообщения по умолчанию (DefaultMessage).

Body -> (строка)

Текст сценария для использования в голосовом сообщении.

LanguageCode -> (строка)

Код языка для использования при синтезе текста сценария сообщения. Список поддерживаемых языков и коды для каждого из них см. в руководстве разработчика Amazon Polly.

OriginationNumber -> (строка)

Длинный код для отправки голосового сообщения. Это значение должно быть одним из выделенных длинных кодов, назначенных вашей учетной записи AWS. Хотя это не обязательно, мы рекомендуем указать длинный код в формате E.164, например +12065550100, чтобы обеспечить своевременную и точную доставку сообщения.

Substitutions -> (отображение)

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

key -> (строка)

value -> (список)

(строка)

VoiceId -> (строка)

Название голоса для использования при доставке сообщения. Список поддерживаемых голосов см. в руководстве разработчика Amazon Polly.

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

Шаблон сообщения для использования в сообщении.

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

Шаблон электронного письма для использования в сообщении.

Name -> (строка)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно является версией шаблона, которая была в последний раз просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

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

Шаблон уведомлений push для использования в сообщении.

Name -> (строка)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно является версией шаблона, которая была в последний раз просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

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

Шаблон SMS для использования в сообщении.

Name -> (строка)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно является версией шаблона, которая была в последний раз просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

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

Шаблон голосового сообщения для использования в сообщении. Этот объект не поддерживается для кампаний.

Name -> (строка)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно является версией шаблона, которая была в последний раз просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

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

Шаблон InApp для использования в сообщении. Объект шаблона InApp не поддерживается для SendMessages.

Name -> (строка)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно является версией шаблона, которая была в последний раз просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

TraceId -> (строка)

Уникальный идентификатор для отслеживания сообщения. Этот идентификатор виден получателям сообщений.

Users -> (отображение)

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

key -> (строка)

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

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

BodyOverride -> (строка)

Тело сообщения. Если указано, это значение переопределяет тело сообщения по умолчанию.

Context -> (отображение)

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

Для уведомления push эта нагрузка добавляется к объекту data.pinpoint. Для электронных писем или текстовых сообщений эта нагрузка добавляется к атрибутам события доставки электронных писем/SMS.

key -> (строка)

value -> (строка)

RawContent -> (строка)

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

Substitutions -> (отображение)

Отображение переменных сообщения, которые нужно объединить с переменными, указанными для сообщения по умолчанию (DefaultMessage.Substitutions). Переменные, указанные в этом отображении, имеют приоритет над всеми другими переменными.

key -> (строка)

value -> (список)

(строка)

TitleOverride -> (строка)

Заголовок или предмет сообщения. Если указано, это значение переопределяет заголовок или предмет сообщения по умолчанию.

Синтаксис JSON:

{
  "Context": {"string": "string"
    ...},
  "MessageConfiguration": {
    "ADMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ConsolidationKey": "string",
      "Data": {"string": "string"
        ...},
      "ExpiresAfter": "string",
      "IconReference": "string",
      "ImageIconUrl": "string",
      "ImageUrl": "string",
      "MD5": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "SmallImageIconUrl": "string",
      "Sound": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "Title": "string",
      "Url": "string"
    },
    "APNSMessage": {
      "APNSPushType": "string",
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Badge": integer,
      "Body": "string",
      "Category": "string",
      "CollapseId": "string",
      "Data": {"string": "string"
        ...},
      "MediaUrl": "string",
      "PreferredAuthenticationMethod": "string",
      "Priority": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "Sound": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "ThreadId": "string",
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "BaiduMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "Data": {"string": "string"
        ...},
      "IconReference": "string",
      "ImageIconUrl": "string",
      "ImageUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "SmallImageIconUrl": "string",
      "Sound": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "DefaultMessage": {
      "Body": "string",
      "Substitutions": {"string": ["string", ...]
        ...}
    },
    "DefaultPushNotificationMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "Data": {"string": "string"
        ...},
      "SilentPush": true|false,
      "Substitutions": {"string": ["string", ...]
        ...},
      "Title": "string",
      "Url": "string"
    },
    "EmailMessage": {
      "Body": "string",
      "FeedbackForwardingAddress": "string",
      "FromAddress": "string",
      "RawEmail": {
        "Data": blob
      },
      "ReplyToAddresses": ["string", ...],
      "SimpleEmail": {
        "HtmlPart": {
          "Charset": "string",
          "Data": "string"
        },
        "Subject": {
          "Charset": "string",
          "Data": "string"
        },
        "TextPart": {
          "Charset": "string",
          "Data": "string"
        },
        "Headers": [
          {
            "Name": "string",
            "Value": "string"
          }
          ...
        ]
      },
      "Substitutions": {"string": ["string", ...]
        ...}
    },
    "GCMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "CollapseKey": "string",
      "Data": {"string": "string"
        ...},
      "IconReference": "string",
      "ImageIconUrl": "string",
      "ImageUrl": "string",
      "PreferredAuthenticationMethod": "string",
      "Priority": "string",
      "RawContent": "string",
      "RestrictedPackageName": "string",
      "SilentPush": true|false,
      "SmallImageIconUrl": "string",
      "Sound": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "SMSMessage": {
      "Body": "string",
      "Keyword": "string",
      "MediaUrl": "string",
      "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
      "OriginationNumber": "string",
      "SenderId": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "EntityId": "string",
      "TemplateId": "string"
    },
    "VoiceMessage": {
      "Body": "string",
      "LanguageCode": "string",
      "OriginationNumber": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "VoiceId": "string"
    }
  },
  "TemplateConfiguration": {
    "EmailTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "PushTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "SMSTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "VoiceTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "InAppTemplate": {
      "Name": "string",
      "Version": "string"
    }
  },
  "TraceId": "string",
  "Users": {"string": {
        "BodyOverride": "string",
        "Context": {"string": "string"
          ...},
        "RawContent": "string",
        "Substitutions": {"string": ["string", ...]
          ...},
        "TitleOverride": "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 (boolean)

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

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить кли-паджинатор для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

Для использования следующих примеров необходимо иметь установленный и настроенный AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

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

Для отправки SMS-сообщения пользователю приложения

Следующий send-users-messages пример отправляет прямое сообщение пользователю приложения.

aws pinpoint send-users-messages \
    --application-id 611e3e3cdd47474c9c1399a505665b91 \
    --send-users-message-request file://myfile.json \
    --region us-west-2

Содержимое myfile.json:

{
    "MessageConfiguration": {
        "SMSMessage": {
            "Body": "hello, how are you?"
        }
    },
    "Users": {
        "testuser": {}
    }
}

Вывод:

{
    "SendUsersMessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "RequestId": "e0b12cf5-2359-11e9-bb0b-d5fb91876b25",
        "Result": {
            "testuser": {
                "testuserendpoint": {
                    "DeliveryStatus": "SUCCESSFUL",
                    "MessageId": "7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "StatusCode": 200,
                    "StatusMessage": "MessageId: 7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0",
                    "Address": "+12345678900"
                }
            }
        }
    }
}

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

Вывод

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

Предоставляет информацию о пользователях и конечных точках, которым было отправлено сообщение.

ApplicationId -> (строка)

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

RequestId -> (строка)

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

Result -> (массив)

Объект, указывающий, на какие конечные точки было отправлено сообщение для каждого пользователя. Объект перечисляет идентификаторы пользователей и, для каждого идентификатора пользователя, предоставляет идентификаторы конечных точек, на которые было отправлено сообщение. Для каждого идентификатора конечной точки предоставляется объект EndpointMessageResult.

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

значение -> (массив)

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

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

Предоставляет информацию о статусе доставки и результатах отправки сообщения непосредственно на конечную точку.

Address -> (строка)

Адрес конечной точки, на которую было доставлено сообщение.

DeliveryStatus -> (строка)

Статус доставки сообщения. Возможные значения:

  • DUPLICATE - адрес конечной точки является дубликатом другого адреса конечной точки. Amazon Pinpoint не будет пытаться повторно отправить сообщение.
  • OPT_OUT - пользователь, связанный с конечной точкой, отказался от получения сообщений от вас. Amazon Pinpoint не будет пытаться повторно отправить сообщение.
  • PERMANENT_FAILURE - во время доставки сообщения на конечную точку произошла ошибка. Amazon Pinpoint не будет пытаться повторно отправить сообщение.
  • SUCCESSFUL - сообщение было успешно доставлено на конечную точку.
  • TEMPORARY_FAILURE - произошла временная ошибка. Amazon Pinpoint не будет пытаться повторно отправить сообщение.
  • THROTTLED - Amazon Pinpoint ограничил операцию отправки сообщения на конечную точку.
  • UNKNOWN_FAILURE - произошла неизвестная ошибка.

MessageId -> (строка)

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

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

Код состояния службы получателя для доставки сообщения.

StatusMessage -> (строка)

Сообщение состояния для доставки сообщения.

UpdatedToken -> (строка)

Для push-уведомлений, отправленных через канал GCM, указывает, был ли обновлён токен регистрации устройства конечной точки в процессе доставки сообщения.

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

Spec-Zone.ru

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