Interface SendRcsMessageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendRcsMessageRequest.Builder,SendRcsMessageRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<SendRcsMessageRequest.Builder,SendRcsMessageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SendRcsMessageRequest
@Mutable @NotThreadSafe public static interface SendRcsMessageRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<SendRcsMessageRequest.Builder,SendRcsMessageRequest>

  • Method Details

    • destinationPhoneNumber

      SendRcsMessageRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)

      The destination phone number in E.164 format.

      Parameters:
      destinationPhoneNumber - The destination phone number in E.164 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originationIdentity

      SendRcsMessageRequest.Builder originationIdentity(String originationIdentity)

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

      Parameters:
      originationIdentity - The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rcsMessageContent

      SendRcsMessageRequest.Builder rcsMessageContent(RcsMessageContent rcsMessageContent)

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

      Parameters:
      rcsMessageContent - The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rcsMessageContent

      default SendRcsMessageRequest.Builder rcsMessageContent(Consumer<RcsMessageContent.Builder> rcsMessageContent)

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

      This is a convenience method that creates an instance of the RcsMessageContent.Builder avoiding the need to create one manually via RcsMessageContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rcsMessageContent(RcsMessageContent).

      Parameters:
      rcsMessageContent - a consumer that will call methods on RcsMessageContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeToLive

      SendRcsMessageRequest.Builder timeToLive(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageTrafficType

      SendRcsMessageRequest.Builder messageTrafficType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fallbackConfiguration

      SendRcsMessageRequest.Builder fallbackConfiguration(RcsFallbackConfiguration 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fallbackConfiguration

      default SendRcsMessageRequest.Builder fallbackConfiguration(Consumer<RcsFallbackConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the RcsFallbackConfiguration.Builder avoiding the need to create one manually via RcsFallbackConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fallbackConfiguration(RcsFallbackConfiguration).

      Parameters:
      fallbackConfiguration - a consumer that will call methods on RcsFallbackConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protectConfigurationId

      SendRcsMessageRequest.Builder protectConfigurationId(String protectConfigurationId)

      The unique identifier of the protect configuration to use.

      Parameters:
      protectConfigurationId - The unique identifier of the protect configuration to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationSetName

      SendRcsMessageRequest.Builder configurationSetName(String configurationSetName)

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

      Parameters:
      configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxPrice

      SendRcsMessageRequest.Builder maxPrice(String maxPrice)

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

      Parameters:
      maxPrice - The maximum amount that you want to spend, in US dollars, per each RCS message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      SendRcsMessageRequest.Builder dryRun(Boolean dryRun)

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

      Parameters:
      dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

      SendRcsMessageRequest.Builder context(Map<String,String> context)

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

      Parameters:
      context - You can specify custom data in this field. If you do, that data is logged to the event destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageFeedbackEnabled

      SendRcsMessageRequest.Builder messageFeedbackEnabled(Boolean 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 PutMessageFeedback.

      Parameters:
      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 PutMessageFeedback.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SendRcsMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendRcsMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.