Item
An item - message or event - that has been sent.
Contents
- AbsoluteTime
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- Attachments
-
Provides information about the attachments.
Type: Array of AttachmentItem objects
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Content
-
The content of the message or event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16384.
Required: No
- ContentType
-
The type of content of the item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- DisplayName
-
The chat display name of the sender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Id
-
The ID of the item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- MessageMetadata
-
The metadata related to the message. Currently this supports only information related to message receipts.
Type: MessageMetadata object
Required: No
- ParticipantId
-
The ID of the sender in the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- ParticipantRole
-
The role of the sender. For example, is it a customer, agent, or system.
Type: String
Valid Values:
AGENT | CUSTOMER | SYSTEM | CUSTOM_BOT | SUPERVISORRequired: No
- RelatedContactId
-
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: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Type
-
Type of the item: message or event.
Type: String
Valid Values:
TYPING | PARTICIPANT_JOINED | PARTICIPANT_LEFT | CHAT_ENDED | TRANSFER_SUCCEEDED | TRANSFER_FAILED | MESSAGE | EVENT | ATTACHMENT | CONNECTION_ACK | MESSAGE_DELIVERED | MESSAGE_READRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
