Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

send-users-messages

Description

Use this resource to message a list of users. Amazon Pinpoint sends the message to all of the endpoints that are associated with each user. A user represents an individual who is assigned a unique user ID, and this ID is assigned to one or more endpoints. For example, if an individual uses your app on multiple devices, your app could assign that person's user ID to the endpoint for each device. With the users-messages resource, you specify the message recipients as user IDs. For each user ID, Amazon Pinpoint delivers the message to all of the user's endpoints. Within the body of your request, you can specify a default message, and you can tailor your message for different channels, including those for mobile push and SMS. With this resource, you send a direct message, which is a one time message that you send to a limited audience without creating a campaign. You can send the message to up to 100 users per request. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of using the users-messages resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--application-id (string) The unique ID of your Amazon Pinpoint application.

--send-users-message-request (structure) Send message request.

JSON Syntax:

{
  "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": {
      "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"
    },
    "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", ...]
        ...}
    }
  },
  "Users": {"string": {
        "BodyOverride": "string",
        "Context": {"string": "string"
          ...},
        "RawContent": "string",
        "Substitutions": {"string": ["string", ...]
          ...},
        "TitleOverride": "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.

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

SendUsersMessageResponse -> (structure)

User send message response.

ApplicationId -> (string)

The unique ID of the Amazon Pinpoint project used to send the message.

RequestId -> (string)

The unique ID assigned to the users-messages request.

Result -> (map)

An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.

key -> (string)

value -> (map)

key -> (string)

value -> (structure)

The result from sending a message to an endpoint.

Address -> (string)

Address that endpoint message was delivered to.

DeliveryStatus -> (string)

Delivery status of message.

MessageId -> (string)

Unique message identifier associated with the message that was sent.

StatusCode -> (integer)

Downstream service status code.

StatusMessage -> (string)

Status message for message delivery.

UpdatedToken -> (string)

If token was updated as part of delivery. (This is GCM Specific)