v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.

post/#X-Amz-Target=PinpointSMSVoiceV2.CreateRcsAgent

Headers

X-Amz-Target'PinpointSMSVoiceV2.CreateRcsAgent' required

Request body

DeletionProtectionEnabledboolean

By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the <a>UpdateRcsAgent</a> action.

OptOutListNamestring

The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

ClientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Response

Success

RcsAgentArnstring required

The Amazon Resource Name (ARN) of the newly created RCS agent.

RcsAgentIdstring required

The unique identifier for the RCS agent.

Status'CREATED' | 'PENDING' | 'TESTING' | 'PARTIAL' | 'ACTIVE' | 'DELETED' required

The current status of the RCS agent.

DeletionProtectionEnabledboolean required

When set to true deletion protection is enabled. By default this is set to false.

OptOutListNamestring

The name of the OptOutList associated with the RCS agent.

CreatedTimestampstring date-time required

The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.

SelfManagedOptOutsEnabledboolean required

By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

TwoWayChannelArnstring

The Amazon Resource Name (ARN) of the two way channel.

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

TwoWayEnabledboolean required

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayMediaS3BucketNamestring

The name of the S3 bucket where inbound RCS media files are stored.

TwoWayMediaS3KeyPrefixstring

The key prefix used for inbound RCS media objects in the S3 bucket.

TwoWayMediaS3Rolestring

The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it.

TwoWayRcsEventsEnabledRcsEventType[]

The list of RCS event types enabled for two-way messaging on the agent.