Skip to content

ChannelMessageCallback

Used by
Source code in docs_src/capo_chime_sdk_messaging/types/channel_message_callback.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class ChannelMessageCallback(TypedDict, closed=True):
    message_id: "capo_chime_sdk_messaging.types.message_id.MessageId"
    """<p>The message ID.</p>"""
    content: NotRequired[
        "capo_chime_sdk_messaging.types.non_empty_content.NonEmptyContent"
    ]
    """<p>The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""
    metadata: NotRequired["capo_chime_sdk_messaging.types.metadata.Metadata"]
    """<p>The message metadata.</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 channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""
    sub_channel_id: NotRequired[
        "capo_chime_sdk_messaging.types.sub_channel_id.SubChannelId"
    ]
    """<p>The ID of the SubChannel.</p>"""
    content_type: NotRequired["capo_chime_sdk_messaging.types.content_type.ContentType"]
    """<p>The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>"""

content instance-attribute 

content: NotRequired[NonEmptyContent]

The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

content_type instance-attribute 

content_type: NotRequired[ContentType]

The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

message_attributes instance-attribute 

message_attributes: NotRequired[MessageAttributeMap]

The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.

message_id instance-attribute 

message_id: MessageId

The message ID.

metadata instance-attribute 

metadata: NotRequired[Metadata]

The message metadata.

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.