Skip to content

Creates a new RCS agent for sending rich messages through the RCS channel

Description

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.

Usage

pinpointsmsvoicev2_create_rcs_agent(DeletionProtectionEnabled,
  OptOutListName, Tags, ClientToken)

Arguments

  • DeletionProtectionEnabled

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 update_rcs_agent action.

  • OptOutListName

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

  • Tags

An array of tags (key and value pairs) associated with the RCS agent.

  • ClientToken

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.

Value

A list with the following syntax:

list(
  RcsAgentArn = "string",
  RcsAgentId = "string",
  Status = "CREATED"|"PENDING"|"TESTING"|"PARTIAL"|"ACTIVE"|"DELETED",
  DeletionProtectionEnabled = TRUE|FALSE,
  OptOutListName = "string",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  SelfManagedOptOutsEnabled = TRUE|FALSE,
  TwoWayChannelArn = "string",
  TwoWayChannelRole = "string",
  TwoWayEnabled = TRUE|FALSE,
  TwoWayMediaS3BucketName = "string",
  TwoWayMediaS3KeyPrefix = "string",
  TwoWayMediaS3Role = "string",
  TwoWayRcsEventsEnabled = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$create_rcs_agent(
  DeletionProtectionEnabled = TRUE|FALSE,
  OptOutListName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)