Skip to content

Item

Source code in docs_src/capo_connectparticipant/types/item.py
class Item(TypedDict, closed=True):
    absolute_time: NotRequired["capo_connectparticipant.types.instant.Instant"]
    """<p>The time when the message or event was sent.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>"""
    content: NotRequired["capo_connectparticipant.types.chat_content.ChatContent"]
    """<p>The content of the message or event.</p>"""
    content_type: NotRequired[
        "capo_connectparticipant.types.chat_content_type.ChatContentType"
    ]
    """<p>The type of content of the item.</p>"""
    id: NotRequired["capo_connectparticipant.types.chat_item_id.ChatItemId"]
    """<p>The ID of the item.</p>"""
    type: NotRequired["capo_connectparticipant.types.chat_item_type.ChatItemType"]
    """<p>Type of the item: message or event. </p>"""
    participant_id: NotRequired[
        "capo_connectparticipant.types.participant_id.ParticipantId"
    ]
    """<p>The ID of the sender in the session.</p>"""
    display_name: NotRequired["capo_connectparticipant.types.display_name.DisplayName"]
    """<p>The chat display name of the sender.</p>"""
    participant_role: NotRequired[
        "capo_connectparticipant.types.participant_role.ParticipantRole"
    ]
    """<p>The role of the sender. For example, is it a customer, agent, or system.</p>"""
    attachments: NotRequired["capo_connectparticipant.types.attachments.Attachments"]
    """<p>Provides information about the attachments.</p>"""
    message_metadata: NotRequired[
        "capo_connectparticipant.types.message_metadata.MessageMetadata"
    ]
    """<p>The metadata related to the message. Currently this supports only information related to message receipts.</p>"""
    related_contact_id: NotRequired[
        "capo_connectparticipant.types.contact_id.ContactId"
    ]
    """<p>The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>"""
    contact_id: NotRequired["capo_connectparticipant.types.contact_id.ContactId"]
    """<p>The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.</p>"""

absolute_time instance-attribute

absolute_time: NotRequired[Instant]

The time when the message or event was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

attachments instance-attribute

attachments: NotRequired[Attachments]

Provides information about the attachments.

contact_id instance-attribute

contact_id: NotRequired[ContactId]

The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.

content instance-attribute

content: NotRequired[ChatContent]

The content of the message or event.

content_type instance-attribute

content_type: NotRequired[ChatContentType]

The type of content of the item.

display_name instance-attribute

display_name: NotRequired[DisplayName]

The chat display name of the sender.

id instance-attribute

id: NotRequired[ChatItemId]

The ID of the item.

message_metadata instance-attribute

message_metadata: NotRequired[MessageMetadata]

The metadata related to the message. Currently this supports only information related to message receipts.

participant_id instance-attribute

participant_id: NotRequired[ParticipantId]

The ID of the sender in the session.

participant_role instance-attribute

participant_role: NotRequired[ParticipantRole]

The role of the sender. For example, is it a customer, agent, or system.

related_contact_id instance-attribute

related_contact_id: NotRequired[ContactId]

The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.

type instance-attribute

type: NotRequired[ChatItemType]

Type of the item: message or event.