The AISmartReply Object

Represents a smart reply generated by AI with different message formats for various communication channels.

Properties

NameDescriptionTypeRequired
uidThe unique identifier (UID) of the smart replystringYes
created_atThe timestamp when the smart reply was created, in ISO 8601 formatstringYes
updated_atThe timestamp when the smart reply was last updated, in ISO 8601 formatstringYes
displayContains display-related information for the smart reply.objectYes
reasonThe reason why this smart reply was generated, providing context for decision-making.stringYes
payloadContains the generated reply messages for different communication channels.objectYes
evidenceA list of supporting statements or facts that led to the generation of this smart reply.array[string]Yes
matter_uidThe unique identifier of the associated matterstringYes

Display Properties

NameDescriptionTypeRequired
btn_textA human-readable title for the smart reply button.string

Payload Properties

NameDescriptionTypeRequired
email_messageThe generated reply formatted for email communicationstringYes
sms_messageThe generated reply formatted for SMS communicationstringYes
FB_messageThe generated reply formatted for Facebook messagingstringYes
other_messageThe generated reply formatted for other communication channelsstringYes

Example

JSON

{
  "uid": "sr-d290f1ee-6c54-4b01-90e6-d701748f0851",
  "created_at": "2025-02-04T14:00:00.000Z",
  "updated_at": "2025-02-04T14:00:00.000Z",
  "display": {
    "btn_text": "Generate Reply"
  },
  "reason": "User needs clarification on pricing",
  "payload": {
    "email_message": "I need more details to send you a quote<br/>best regards,<br/>ramster",
    "sms_message": "I need more details to send you a quote",
    "FB_message": "I need more details to send you a quote",
    "other_message": "I need more details to send you a quote"
  },
  "evidence": [
    "User asked for price estimate"
  ],
  "matter_uid": "7f8a9b32d4e"
}