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

Send a batch of messages to users

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)

--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", ...]
        ...},
      "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",
      "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
      "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)

Application id of the message.

RequestId -> (string)

Original request Id for which this message was delivered.

Result -> (map)

A map containing of UserId to Map of EndpointId to Endpoint Message Result.

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.

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)