Creates a new RCS message and sends it to a recipient's phone number¶

Description¶

Creates a new RCS message and sends it to a recipient's phone number. RCS messages support rich content including text, files, rich cards, and carousels with interactive suggested actions.

Usage¶

pinpointsmsvoicev2_send_rcs_message(DestinationPhoneNumber,
  OriginationIdentity, RcsMessageContent, TimeToLive, MessageTrafficType,
  FallbackConfiguration, ProtectConfigurationId, ConfigurationSetName,
  MaxPrice, DryRun, Context, MessageFeedbackEnabled)

Arguments¶

DestinationPhoneNumber

[required] The destination phone number in E.164 format.
OriginationIdentity

[required] The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
RcsMessageContent

The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.
TimeToLive

The duration in seconds that the RCS message is valid for delivery. If the message cannot be delivered within this duration, it is considered expired. Valid values are 1 to 172800 (48 hours). If a FallbackConfiguration is provided, the fallback is triggered when the duration expires without delivery confirmation.
MessageTrafficType

The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.
FallbackConfiguration

Configuration for SMS or MMS fallback when RCS delivery fails. If provided, the service sends a fallback message via the specified channel when the RCS message fails or the TimeToLive expires.
ProtectConfigurationId

The unique identifier of the protect configuration to use.
ConfigurationSetName

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
MaxPrice

The maximum amount that you want to spend, in US dollars, per each RCS message.
DryRun

When set to true, the message is checked and validated, but isn't sent to the end recipient.
Context

You can specify custom data in this field. If you do, that data is logged to the event destination.
MessageFeedbackEnabled

Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using put_message_feedback.

Value¶

A list with the following syntax:

list(
  MessageId = "string"
)

Request syntax¶

svc$send_rcs_message(
  DestinationPhoneNumber = "string",
  OriginationIdentity = "string",
  RcsMessageContent = list(
    Content = list(
      TextMessage = list(
        Body = "string"
      ),
      FileMessage = list(
        FileUrl = "string",
        ThumbnailUrl = "string"
      ),
      RichCard = list(
        CardOrientation = "string",
        ThumbnailImageAlignment = "string",
        CardContent = list(
          Title = "string",
          Description = "string",
          Media = list(
            FileUrl = "string",
            ThumbnailUrl = "string",
            Height = "string"
          ),
          Suggestions = list(
            list(
              Reply = list(
                Text = "string",
                PostbackData = "string"
              ),
              OpenUrl = list(
                Text = "string",
                PostbackData = "string",
                Url = "string",
                Application = "string",
                WebviewViewMode = "string"
              ),
              DialPhone = list(
                Text = "string",
                PostbackData = "string",
                PhoneNumber = "string"
              ),
              ShowLocation = list(
                Text = "string",
                PostbackData = "string",
                Latitude = 123.0,
                Longitude = 123.0,
                Label = "string"
              ),
              RequestLocation = list(
                Text = "string",
                PostbackData = "string"
              ),
              CreateCalendarEvent = list(
                Text = "string",
                PostbackData = "string",
                Title = "string",
                StartTime = as.POSIXct(
                  "2015-01-01"
                ),
                EndTime = as.POSIXct(
                  "2015-01-01"
                ),
                Description = "string"
              )
            )
          )
        )
      ),
      Carousel = list(
        CardWidth = "string",
        CardContents = list(
          list(
            Title = "string",
            Description = "string",
            Media = list(
              FileUrl = "string",
              ThumbnailUrl = "string",
              Height = "string"
            ),
            Suggestions = list(
              list(
                Reply = list(
                  Text = "string",
                  PostbackData = "string"
                ),
                OpenUrl = list(
                  Text = "string",
                  PostbackData = "string",
                  Url = "string",
                  Application = "string",
                  WebviewViewMode = "string"
                ),
                DialPhone = list(
                  Text = "string",
                  PostbackData = "string",
                  PhoneNumber = "string"
                ),
                ShowLocation = list(
                  Text = "string",
                  PostbackData = "string",
                  Latitude = 123.0,
                  Longitude = 123.0,
                  Label = "string"
                ),
                RequestLocation = list(
                  Text = "string",
                  PostbackData = "string"
                ),
                CreateCalendarEvent = list(
                  Text = "string",
                  PostbackData = "string",
                  Title = "string",
                  StartTime = as.POSIXct(
                    "2015-01-01"
                  ),
                  EndTime = as.POSIXct(
                    "2015-01-01"
                  ),
                  Description = "string"
                )
              )
            )
          )
        )
      )
    ),
    Suggestions = list(
      list(
        Reply = list(
          Text = "string",
          PostbackData = "string"
        ),
        OpenUrl = list(
          Text = "string",
          PostbackData = "string",
          Url = "string",
          Application = "string",
          WebviewViewMode = "string"
        ),
        DialPhone = list(
          Text = "string",
          PostbackData = "string",
          PhoneNumber = "string"
        ),
        ShowLocation = list(
          Text = "string",
          PostbackData = "string",
          Latitude = 123.0,
          Longitude = 123.0,
          Label = "string"
        ),
        RequestLocation = list(
          Text = "string",
          PostbackData = "string"
        ),
        CreateCalendarEvent = list(
          Text = "string",
          PostbackData = "string",
          Title = "string",
          StartTime = as.POSIXct(
            "2015-01-01"
          ),
          EndTime = as.POSIXct(
            "2015-01-01"
          ),
          Description = "string"
        )
      )
    )
  ),
  TimeToLive = 123,
  MessageTrafficType = "string",
  FallbackConfiguration = list(
    Channel = "SMS"|"MMS",
    MessageBody = "string",
    MediaUrls = list(
      "string"
    ),
    OriginationIdentity = "string"
  ),
  ProtectConfigurationId = "string",
  ConfigurationSetName = "string",
  MaxPrice = "string",
  DryRun = TRUE|FALSE,
  Context = list(
    "string"
  ),
  MessageFeedbackEnabled = TRUE|FALSE
)