Skip to content

SendChannelMessageRequest

Source code in docs_src/capo_chime_sdk_messaging/types/send_channel_message_request.py
class SendChannelMessageRequest(TypedDict, closed=True):
    channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the channel.</p>"""
    content: "capo_chime_sdk_messaging.types.non_empty_content.NonEmptyContent"
    """<p>The content of the channel message.</p>"""
    type: "capo_chime_sdk_messaging.types.channel_message_type.ChannelMessageType"
    """<p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p> <p> <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.</p> <p> <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata.</p>"""
    persistence: "capo_chime_sdk_messaging.types.channel_message_persistence_type.ChannelMessagePersistenceType"
    """<p>Boolean that controls whether the message is persisted on the back end. Required.</p>"""
    metadata: NotRequired["capo_chime_sdk_messaging.types.metadata.Metadata"]
    """<p>The optional metadata for each message.</p>"""
    client_request_token: (
        "capo_chime_sdk_messaging.types.client_request_token.ClientRequestToken"
    )
    """<p>The <code>Idempotency</code> token for each client request.</p>"""
    chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>"""
    push_notification: NotRequired[
        "capo_chime_sdk_messaging.types.push_notification_configuration.PushNotificationConfiguration"
    ]
    """<p>The push notification configuration of the message.</p>"""
    message_attributes: NotRequired[
        "capo_chime_sdk_messaging.types.message_attribute_map.MessageAttributeMap"
    ]
    """<p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.</p>"""
    sub_channel_id: NotRequired[
        "capo_chime_sdk_messaging.types.sub_channel_id.SubChannelId"
    ]
    """<p>The ID of the SubChannel in the request.</p>"""
    content_type: NotRequired["capo_chime_sdk_messaging.types.content_type.ContentType"]
    """<p>The content type of the channel message.</p>"""
    target: NotRequired["capo_chime_sdk_messaging.types.target_list.TargetList"]
    """<p>The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see. </p>"""

channel_arn instance-attribute

channel_arn: ChimeArn

The ARN of the channel.

chime_bearer instance-attribute

chime_bearer: ChimeArn

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

client_request_token instance-attribute

client_request_token: ClientRequestToken

The Idempotency token for each client request.

content instance-attribute

content: NonEmptyContent

The content of the channel message.

content_type instance-attribute

content_type: NotRequired[ContentType]

The content type of the channel message.

message_attributes instance-attribute

message_attributes: NotRequired[MessageAttributeMap]

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

metadata instance-attribute

metadata: NotRequired[Metadata]

The optional metadata for each message.

persistence instance-attribute

Boolean that controls whether the message is persisted on the back end. Required.

push_notification instance-attribute

push_notification: NotRequired[PushNotificationConfiguration]

The push notification configuration of the message.

sub_channel_id instance-attribute

sub_channel_id: NotRequired[SubChannelId]

The ID of the SubChannel in the request.

target instance-attribute

target: NotRequired[TargetList]

The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

type instance-attribute

The type of message, STANDARD or CONTROL.

STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.