Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

отправка-сообщений

Описание

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

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

Синтаксис

  send-messages
--application-id <value>
--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.

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

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

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

Отображение пар «ключ-значение», где каждый ключ — адрес, а каждое значение — объект AddressConfiguration. Адрес может быть токеном push-уведомления, номером телефона или адресом электронной почты. Вы можете использовать объект AddressConfiguration, чтобы настроить сообщение для адреса, указав такие настройки, как переопределения содержимого и переменные сообщения.

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

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

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

BodyOverride -> (строка)

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

ChannelType -> (строка)

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

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

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

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

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

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

RawContent -> (строка)

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

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

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

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

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

(строка)

TitleOverride -> (строка)

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

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

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

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

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

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

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

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

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

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

BodyOverride -> (строка)

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

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

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

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

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

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

RawContent -> (строка)

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

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

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

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

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

(строка)

TitleOverride -> (строка)

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

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 -> (строка)

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

RawContent -> (строка)

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

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

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

SmallImageIconUrl -> (строка)

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

Sound -> (строка)

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

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

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

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

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

(строка)

Title -> (строка)

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

Url -> (строка)

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

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

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

APNSPushType -> (строка)

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

  • 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 -> (строка)

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

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

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

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

Body -> (строка)

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

Category -> (строка)

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

CollapseId -> (строка)

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

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

Data -> (карта)

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

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

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

MediaUrl -> (строка)

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

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, используемая в качестве данных для сообщения уведомления. Если указано, это значение переопределяет всё остальное содержимое сообщения.

Примечание

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

SilentPush -> (булево)

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

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

Примечание

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

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

Sound -> (строка)

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

Substitutions -> (карта)

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

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

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

(строка)

ThreadId -> (строка)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

Data -> (карта)

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

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

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

IconReference -> (строка)

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

ImageIconUrl -> (строка)

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

ImageUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

SmallImageIconUrl -> (строка)

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

Sound -> (строка)

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

Substitutions -> (карта)

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

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

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

(строка)

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

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

Title -> (строка)

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

Url -> (строка)

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

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

Значение сообщения по умолчанию для всех каналов.

Body -> (строка)

Тело сообщения по умолчанию.

Substitutions -> (словарь)

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

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

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

(строка)

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

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

Action -> (строка)

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

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

Body -> (строка)

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

Data -> (словарь)

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

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

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

SilentPush -> (булево)

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

Substitutions -> (словарь)

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

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

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

(строка)

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FeedbackForwardingAddress -> (строка)

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

FromAddress -> (строка)

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

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

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

Data -> (бинарный объект)

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

ReplyToAddresses -> (список)

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

(строка)

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

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

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

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

Charset -> (строка)

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

Data -> (строка)

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

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

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

Charset -> (строка)

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

Data -> (строка)

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

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

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

Charset -> (строка)

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

Data -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину любых рендеренных атрибутов. Например, если вы добавляете атрибут {CreationDate}, он рендерится как ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ и имеет длину 24 символа.

Substitutions -> (словарь)

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

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

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

(строка)

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

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

Action -> (строка)

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

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

Body -> (строка)

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

CollapseKey -> (строка)

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

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

Data -> (словарь)

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

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

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

IconReference -> (строка)

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

ImageIconUrl -> (строка)

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

ImageUrl -> (строка)

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

PreferredAuthenticationMethod -> (строка)

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

Priority -> (строка)

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

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

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

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

RawContent -> (строка)

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

RestrictedPackageName -> (строка)

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

SilentPush -> (булево)

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

SmallImageIconUrl -> (строка)

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

Sound -> (строка)

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

Substitutions -> (словарь)

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

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

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

(строка)

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

Keyword -> (строка)

Имя программы SMS, которое вы предоставили службе поддержки AWS при запросе выделенного номера.

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 -> (строка)

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

Синтаксис JSON:

{
  "Addresses": {"string": {
        "BodyOverride": "string",
        "ChannelType": "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP",
        "Context": {"string": "string"
          ...},
        "RawContent": "string",
        "Substitutions": {"string": ["string", ...]
          ...},
        "TitleOverride": "string"
      }
    ...},
  "Context": {"string": "string"
    ...},
  "Endpoints": {"string": {
        "BodyOverride": "string",
        "Context": {"string": "string"
          ...},
        "RawContent": "string",
        "Substitutions": {"string": ["string", ...]
          ...},
        "TitleOverride": "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"
}

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

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы с AWS CLI (AWS CLI User Guide).

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

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

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

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

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

{
    "MessageConfiguration": {
        "SMSMessage": {
            "Body": "hello, how are you?"
        }
    },
    "Endpoints": {
        "testendpoint": {}
    }
}

Вывод:

{
    "MessageResponse": {
        "ApplicationId": "611e3e3cdd47474c9c1399a505665b91",
        "EndpointResult": {
            "testendpoint": {
                "Address": "+12345678900",
                "DeliveryStatus": "SUCCESSFUL",
                "MessageId": "itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0",
                "StatusCode": 200,
                "StatusMessage": "MessageId: itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0"
            }
        },
        "RequestId": "c7e23264-04b2-4a46-b800-d24923f74753"
    }
}

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

Вывод

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

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

ApplicationId -> (строка)

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

EndpointResult -> (карта)

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

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

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

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

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

RequestId -> (строка)

Идентификатор исходного запроса, для которого было доставлено сообщение.

Result -> (карта)

Карта, содержащая многокомпонентный ответ для каждого адреса (электронный адрес, номер телефона или токен push-уведомления), которому было отправлено сообщение. В карте адрес — ключ, а результат — значение.

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

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

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

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