OBJECT
TextMessageEntity
Message sent or received in a text message conversation or in an AI assistant chat.
link GraphQL Schema definition
- type TextMessageEntity {
- # True when the record is protected against deletion because it must always exist
- # in the space. Deleting a record that is not protected can still fail on other
- # checks. Read-only.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # AI assistant chat conversation this message belongs to, when applicable.
- : ChatConversationEntity
- # Conversation this message belongs to. Empty for messages produced by AI chat
- # that do not belong to a thread of customer conversation.
- : TextMessageConversationEntity
- # Id of the AI assistant chat conversation this message belongs to, when
- # applicable.
- : ID
- # Body of the message. May be plain text or a JSON payload (e.g. AI assistant
- # examples / suggestions).
- : String!
- # Timestamp the message was sent.
- : DateTime
- # Direction of the message (Incoming, Outgoing).
- : EmailDirectionEnum!
- # External message identifier from the SMS provider (e.g. Twilio Message SID).
- : String
- # Quality score given to the message by the user (e.g. for AI-suggested replies).
- # Used to feed back into the suggestion engine.
- : Int
- # Delivery status of the message: Sending, Sent, Seen or Failed for outgoing
- # messages, Received for incoming ones.
- : TextMessageStatusEnum
- # Id of the text message conversation this message belongs to, or empty for AI
- # assistant chat messages.
- : ID
- # Revision when entity was lastly changed.
- : Int
- # Files attached to the message (e.g. MMS attachments).
- #
- # Arguments
- # filter: Filter CloudObject relations by target CloudObject
- # attributes.
- # filterEdge: Filter CloudObjectRelation relations by edge
- # (relation) CloudObjectRelation attributes.
- # orderBy: Order CloudObject relations by target CloudObject
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : CloudObjectFilterInput,
- : CloudObjectRelationFilterInput,
- : [CloudObjectOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): CloudObjectRelationEntityConnection
- # HTML-rendered version of the message body, ready for display in chat UIs.
- : String!
- # Structured AI payload of the message (examples or suggestions). Empty for
- # regular text messages.
- : AiMessageData
- # List of suggested follow-up prompts produced by the AI for this message. Empty
- # when the AI did not produce prompts.
- : [String!]
- # Permissions the current user has on this record, out of the requested ones.
- #
- # Arguments
- # permissions: Permissions to check; the result lists those the
- # current user has.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- # AI credits consumed by generating this text message, and whether the generation
- # is still in progress. Empty when no AI credits were tracked for the message.
- : AiCreditInfo
- }
link Require by
- ChatConversationRepositoryRead operations for ChatConversation records.
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateTextMessagePayloadResult of the createTextMessage mutation.
- TextMessageConversationRepositoryRead operations for TextMessageConversation records.
- TextMessageEntityEdgeA Relay edge containing a `TextMessageEntity` and its cursor.
- TextMessageRepositoryRead operations for TextMessage records.
- UpdateTextMessagePayloadResult of the updateTextMessage mutation.