SendChannelMessageRequest
¶
Source code in docs_src/capo_chime_sdk_messaging/types/send_channel_message_request.py
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_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
¶
persistence: ChannelMessagePersistenceType
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
¶
type: ChannelMessageType
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.