SunshineConversationsClient::Message
August 27, 2025 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The unique ID of the message. | [optional] |
| received | String | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message. | [optional] |
| author | Author | [optional] | |
| activity | ActivityMessage | Details 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] |
| content | Content | The content of the message. | [optional] |
| source | Source | [optional] | |
| quoted_message | QuotedMessage | The quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages. | [optional] |
| metadata | Hash<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] |
| deleted | Boolean | true 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: {"lang":"en-ca"},
deleted: null
)