Smart Replies (Legacy)

Show CometChat smart reply suggestions with positive, neutral, and negative responses injected into message metadata.

Legacy. Smart Replies are now part of the AI User Copilot in the core messaging experience and no longer require this extension. Legacy extensions are not actively maintained and will not receive feature updates. For the current approach, see Smart Replies (AI User Copilot) and the AI User Copilot overview.

The Smart Reply extension allows you to show quick reply options to a user so that they can easily respond to a message. We will always suggest 3 options; one positive, one neutral and one negative. We also add a category, in case you want to skip some suggestions.

Extension settings

1. Login to CometChat and select your app.
2. Go to the Extensions section and enable the Smart Reply extension.

How does it work?

When a user sends a message, our Smart Reply extension will add metadata while the message is in-flight. The recipient will receive the message with metadata suggesting the responses.

At the recipients’ end, from the message object, you can fetch the metadata by calling the getMetadata() method. Using this metadata, you can fetch suggested responses for the message.

JSON

"@injected": {
  "extensions": {
    "smart-reply": {
          "reply_positive": "<possible positive response>",
          "reply_neutral": "<possible neutral response>",
          "reply_negative": "<possible negative response>",
          "category": "<category>"
    }
  }
}

If the data is missing, it means that the extension has timed out.

Implementation

Using the Smart Reply extension, you can build a UI like this:

JavaScript

var metadata = message.getMetadata();
if (metadata != null) {
  var injectedObject = metadata["@injected"];
  if (injectedObject != null && injectedObject.hasOwnProperty("extensions")) {
    var extensionsObject = injectedObject["extensions"];
    if (
      extensionsObject != null &&
      extensionsObject.hasOwnProperty("smart-reply")
    ) {
      var smartReplyObject = extensionsObject["smart-reply"];
      var reply_positive = smartReplyObject["reply_positive"];
      var reply_neutral = smartReplyObject["reply_neutral"];
      var reply_negative = smartReplyObject["reply_negative"];
      var category = smartReplyObject["category"];
    }
  }
}

Java

JSONObject metadata = message.getMetadata();
if (metadata != null) {
 JSONObject injectedObject = metadata.getJSONObject("@injected");
 if (injectedObject != null && injectedObject.has("extensions")) {
  JSONObject extensionsObject = injectedObject.getJSONObject("extensions");
  if (extensionsObject != null && extensionsObject.has("smart-reply")) {
   JSONObject smartReply = extensionsObject.getJSONObject("smart-reply");
   String reply_positive = smartReply.getString("reply_positive");
   String reply_neutral = smartReply.getString("reply_neutral");
   String reply_negative = smartReply.getString("reply_negative");
   String category = smartReply.getString("category");

  }
 }
}

Kotlin

if (metadata != null) {
  if (metadata.has("@injected")) {
    val injectedJSONObject = metadata.getJSONObject("@injected")
    if (injectedJSONObject != null && injectedJSONObject.has("extensions")) {
    val extensionsObject = injectedJSONObject.getJSONObject("extensions")
    if (extensionsObject.has("smart-reply")) {
    val smartReplyObject = extensionsObject.getJSONObject("smart-reply")
    if (smartReplyObject.has("reply_positive"))
    val reply_positive = smartReplyObject.getString("reply_positive")
    if (smartReplyObject.has("reply_neutral"))
    val reply_neutral = smartReplyObject.getString("reply_neutral")
    if (smartReplyObject.has("reply_negative"))
    val reply_negative = smartReplyObject.getString("reply_negative")
    if (smartReplyObject.has("category"))
    val category = smartReplyObject.getString("category")               
      }
    }
  }
}

Swift

var metadata : [String : Any]? = textMessage.metaData
if metadata != nil {
            
  var injectedObject : [String : Any]? = (metadata?["@injected"] as? [String : Any])!
            
  if injectedObject != nil && (injectedObject!["extensions"] != nil){
                
    var extensionsObject : [String : Any]? = injectedObject?["extensions"] as? [String : Any]
                
    if extensionsObject != nil && extensionsObject?["smart-reply"] != nil {
                    
      var smartReply = extensionsObject?["smart-reply"] as! [String :  Any]
      let reply_positive = smartReply["reply_positive"]
      let reply_neutral = smartReply["reply_neutral"]
      let reply_negative = smartReply["reply_negative"]
      let category = smartReply["category"]
    }
  }
}