Skip to content

SendRcsMessageRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/send_rcs_message_request.py
class SendRcsMessageRequest(TypedDict, closed=True):
    destination_phone_number: (
        "capo_pinpoint_sms_voice_v2.types.phone_number.PhoneNumber"
    )
    """<p>The destination phone number in E.164 format.</p>"""
    origination_identity: "capo_pinpoint_sms_voice_v2.types.rcs_message_origination_identity.RcsMessageOriginationIdentity"
    """<p>The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.</p>"""
    rcs_message_content: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_message_content.RcsMessageContent"
    ]
    """<p>The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.</p>"""
    time_to_live: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_time_to_live.RcsTimeToLive"
    ]
    """<p>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.</p>"""
    message_traffic_type: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_message_traffic_type.RcsMessageTrafficType"
    ]
    """<p>The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.</p>"""
    fallback_configuration: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_fallback_configuration.RcsFallbackConfiguration"
    ]
    """<p>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.</p>"""
    protect_configuration_id: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.protect_configuration_id_or_arn.ProtectConfigurationIdOrArn"
    ]
    """<p>The unique identifier of the protect configuration to use.</p>"""
    configuration_set_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.configuration_set_name_or_arn.ConfigurationSetNameOrArn"
    ]
    """<p>The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.</p>"""
    max_price: NotRequired["capo_pinpoint_sms_voice_v2.types.max_price.MaxPrice"]
    """<p>The maximum amount that you want to spend, in US dollars, per each RCS message.</p>"""
    dry_run: "bool"
    """<p>When set to true, the message is checked and validated, but isn't sent to the end recipient.</p>"""
    context: NotRequired["capo_pinpoint_sms_voice_v2.types.context_map.ContextMap"]
    """<p>You can specify custom data in this field. If you do, that data is logged to the event destination.</p>"""
    message_feedback_enabled: NotRequired["bool"]
    """<p>Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using <a>PutMessageFeedback</a>.</p>"""

configuration_set_name instance-attribute

configuration_set_name: NotRequired[ConfigurationSetNameOrArn]

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

context instance-attribute

context: NotRequired[ContextMap]

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

destination_phone_number instance-attribute

destination_phone_number: PhoneNumber

The destination phone number in E.164 format.

dry_run instance-attribute

dry_run: bool

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

fallback_configuration instance-attribute

fallback_configuration: NotRequired[RcsFallbackConfiguration]

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.

max_price instance-attribute

max_price: NotRequired[MaxPrice]

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

message_feedback_enabled instance-attribute

message_feedback_enabled: NotRequired[bool]

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.

message_traffic_type instance-attribute

message_traffic_type: NotRequired[RcsMessageTrafficType]

The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.

origination_identity instance-attribute

origination_identity: RcsMessageOriginationIdentity

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

protect_configuration_id instance-attribute

protect_configuration_id: NotRequired[ProtectConfigurationIdOrArn]

The unique identifier of the protect configuration to use.

rcs_message_content instance-attribute

rcs_message_content: NotRequired[RcsMessageContent]

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

time_to_live instance-attribute

time_to_live: NotRequired[RcsTimeToLive]

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.