Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

send-messages

Description

Creates and sends a direct message.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-messages
--application-id <value>
--message-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--message-request (structure)

Specifies the objects that define configuration and other settings for a message.

JSON Syntax:

{
  "Addresses": {"string": {
        "BodyOverride": "string",
        "ChannelType": "GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM",
        "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": {
      "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"
        }
      },
      "Substitutions": {"string": ["string", ...]
        ...}
    },
    "GCMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "CollapseKey": "string",
      "Data": {"string": "string"
        ...},
      "IconReference": "string",
      "ImageIconUrl": "string",
      "ImageUrl": "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",
      "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
      "OriginationNumber": "string",
      "SenderId": "string",
      "Substitutions": {"string": ["string", ...]
        ...}
    },
    "VoiceMessage": {
      "Body": "string",
      "LanguageCode": "string",
      "OriginationNumber": "string",
      "Substitutions": {"string": ["string", ...]
        ...},
      "VoiceId": "string"
    }
  },
  "TraceId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

MessageResponse -> (structure)

Provides information about the results of a request to send a message to an endpoint address.

ApplicationId -> (string)

The unique identifier for the application that was used to send the message.

EndpointResult -> (map)

A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

key -> (string)

value -> (structure)

Provides information about the delivery status and results of sending a message directly to an endpoint.

Address -> (string)

The endpoint address that the message was delivered to.

DeliveryStatus -> (string)

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

MessageId -> (string)

The unique identifier for the message that was sent.

StatusCode -> (integer)

The downstream service status code for delivering the message.

StatusMessage -> (string)

The status message for delivering the message.

UpdatedToken -> (string)

For push notifications that are sent through the GCM channel, specifies whether the token was updated as part of delivering the message.

RequestId -> (string)

The identifier for the original request that the message was delivered for.

Result -> (map)

A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

key -> (string)

value -> (structure)

Provides information about the results of sending a message directly to an endpoint address.

DeliveryStatus -> (string)

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint address.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

MessageId -> (string)

The unique identifier for the message that was sent.

StatusCode -> (integer)

The downstream service status code for delivering the message.

StatusMessage -> (string)

The status message for delivering the message.

UpdatedToken -> (string)

For push notifications that are sent through the GCM channel, specifies whether the token was updated as part of delivering the message.