Send Media Message

pinpointsmsvoicev2_send_media_message

R Documentation

Creates a new multimedia message (MMS) and sends it to a recipient's phone number¶

Description¶

Creates a new multimedia message (MMS) and sends it to a recipient's phone number.

Usage¶

pinpointsmsvoicev2_send_media_message(DestinationPhoneNumber,
  OriginationIdentity, MessageBody, MediaUrls, ConfigurationSetName,
  MaxPrice, TimeToLive, Context, DryRun, ProtectConfigurationId)

Arguments¶

DestinationPhoneNumber

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

OriginationIdentity

[required] The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

MessageBody

The text body of the message.

MediaUrls

An array of URLs to each media file to send.

The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.

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

TimeToLive

How long the text message is valid for. By default this is 72 hours.

Context

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

DryRun

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

ProtectConfigurationId

The unique identifier of the protect configuration to use.

Value¶

A list with the following syntax:

list(
  MessageId = "string"
)

Request syntax¶

svc$send_media_message(
  DestinationPhoneNumber = "string",
  OriginationIdentity = "string",
  MessageBody = "string",
  MediaUrls = list(
    "string"
  ),
  ConfigurationSetName = "string",
  MaxPrice = "string",
  TimeToLive = 123,
  Context = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  ProtectConfigurationId = "string"
)