AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Pinpoint SMS Voice V2 SendRcsMessage API operation.

Syntax

Send-SMSVRcsMessage
-RcsMessageContent_Content_TextMessage_Body <String>
-RcsMessageContent_Content_Carousel_CardContent <RcsCarouselCardContent[]>
-RcsMessageContent_Content_RichCard_CardOrientation <String>
-RcsMessageContent_Content_Carousel_CardWidth <String>
-FallbackConfiguration_Channel <RcsFallbackChannel>
-ConfigurationSetName <String>
-Context <Hashtable>
-RcsMessageContent_Content_RichCard_CardContent_Description <String>
-DestinationPhoneNumber <String>
-DryRun <Boolean>
-RcsMessageContent_Content_FileMessage_FileUrl <String>
-RcsMessageContent_Content_RichCard_CardContent_Media_FileUrl <String>
-RcsMessageContent_Content_RichCard_CardContent_Media_Height <String>
-MaxPrice <String>
-FallbackConfiguration_MediaUrl <String[]>
-FallbackConfiguration_MessageBody <String>
-MessageFeedbackEnabled <Boolean>
-MessageTrafficType <String>
-FallbackConfiguration_OriginationIdentity <String>
-OriginationIdentity <String>
-ProtectConfigurationId <String>
-RcsMessageContent_Content_RichCard_CardContent_Suggestion <RcsSuggestedAction[]>
-RcsMessageContent_Suggestion <RcsSuggestedAction[]>
-RcsMessageContent_Content_RichCard_ThumbnailImageAlignment <String>
-RcsMessageContent_Content_FileMessage_ThumbnailUrl <String>
-RcsMessageContent_Content_RichCard_CardContent_Media_ThumbnailUrl <String>
-TimeToLive <Int32>
-RcsMessageContent_Content_RichCard_CardContent_Title <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointSMSVoiceV2Config>

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.

Parameters

-ClientConfig <AmazonPinpointSMSVoiceV2Config>
Amazon.PowerShell.Cmdlets.SMSV.AmazonPinpointSMSVoiceV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationSetName <String>
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <Hashtable>
You can specify custom data in this field. If you do, that data is logged to the event destination. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationPhoneNumber <String>
The destination phone number in E.164 format.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
When set to true, the message is checked and validated, but isn't sent to the end recipient.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FallbackConfiguration_Channel <RcsFallbackChannel>
The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FallbackConfiguration_MediaUrl <String[]>
An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFallbackConfiguration_MediaUrls
-FallbackConfiguration_MessageBody <String>
The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FallbackConfiguration_OriginationIdentity <String>
The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxPrice <String>
The maximum amount that you want to spend, in US dollars, per each RCS message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageFeedbackEnabled <Boolean>
Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageTrafficType <String>
The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OriginationIdentity <String>
The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProtectConfigurationId <String>
The unique identifier of the protect configuration to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_Carousel_CardContent <RcsCarouselCardContent[]>
The list of cards in the carousel. Minimum 2, maximum 10 cards. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRcsMessageContent_Content_Carousel_CardContents
-RcsMessageContent_Content_Carousel_CardWidth <String>
The width of cards in the carousel. Valid values are SMALL and MEDIUM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_FileMessage_FileUrl <String>
The S3 URI of the media file to send, in the format s3://bucket-name/key. The service downloads the file from your S3 bucket, rehosts it, and generates a presigned URL for the aggregator. Maximum 2000 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_FileMessage_ThumbnailUrl <String>
The S3 URI of an optional thumbnail image for the media file, in the format s3://bucket-name/key. Maximum 2000 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardContent_Description <String>
The description text of the card. Maximum 2000 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardContent_Media_FileUrl <String>
The S3 URI of the media file for the card, in the format s3://bucket-name/key. Maximum 2000 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardContent_Media_Height <String>
The display height of the media in the card. Valid values are SHORT, MEDIUM, and TALL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardContent_Media_ThumbnailUrl <String>
The S3 URI of an optional thumbnail image for the card media. Maximum 2000 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardContent_Suggestion <RcsSuggestedAction[]>
Card-level suggested actions. Maximum 4 suggestions per card. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRcsMessageContent_Content_RichCard_CardContent_Suggestions
-RcsMessageContent_Content_RichCard_CardContent_Title <String>
The title of the card. Maximum 200 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_CardOrientation <String>
The orientation of the rich card. Valid values are HORIZONTAL and VERTICAL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_RichCard_ThumbnailImageAlignment <String>
The alignment of the thumbnail image in a horizontal card. Valid values are LEFT and RIGHT. Only applicable when CardOrientation is HORIZONTAL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Content_TextMessage_Body <String>
The text body of the RCS message. Maximum 3072 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RcsMessageContent_Suggestion <RcsSuggestedAction[]>
Message-level suggested actions displayed to the recipient. Maximum 11 suggestions per message. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRcsMessageContent_Suggestions
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MessageId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointSMSVoiceV2.Model.SendRcsMessageResponse). Specifying the name of a property of type Amazon.PinpointSMSVoiceV2.Model.SendRcsMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeToLive <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.PinpointSMSVoiceV2.Model.SendRcsMessageResponse
This cmdlet returns a System.String object. The service call response (type Amazon.PinpointSMSVoiceV2.Model.SendRcsMessageResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z