SunshineConversationsClient::Message

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
idStringThe unique ID of the message.[optional]
receivedStringA datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message.[optional]
authorAuthor[optional]
activityActivityMessageDetails of the system activity that generated this message. This field is used when actions taken by the system generate a persisted message to notify the user or agent of an event that occurred. For example, when a user's Ticket gets closed. This property applies only to informational text messages generated via system events.[optional]
contentContentThe content of the message.[optional]
sourceSource[optional]
quoted_messageQuotedMessageThe quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages.[optional]
metadataHash<String, Object>Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.[optional]
deletedBooleantrue if the message serves as a placeholder for one that has been deleted.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Message.new(
  id: 5e552ef595e5206375bb835d,
  received: 2019-03-21T18:48:52.760Z,
  author: null,
  activity: null,
  content: null,
  source: null,
  quoted_message: null,
  metadata: {&quot;lang&quot;:&quot;en-ca&quot;},
  deleted: null
)