Voice Transcription

Voice transcription extension allows you to convert an audio message into text.

Before you begin

1. Create a Rev.ai account

   Sign up with Rev.ai.

2. Generate an access token

   Get your Rev.ai Access Token for configuring this extension.

Extension settings

1. Open your CometChat app

   Login to CometChat and select your app.

2. Enable Voice Transcription

   Go to Chat & Messaging —> Features, under Extentions and enable Voice Transcription.

3. Add your access token

   Open the settings and enter the Rev.ai Access Token.

4. Save settings

   Save your configuration to activate the extension.

---

Choose Your Integration Method

Choose the integration method that best suits your needs:

UI Kit Builder

• Enable it in both Dashboard and UI Kit Builder settings, then you can use the TinyURL extension in your custom chat experience.

Widget Builder

• Enable it in both Dashboard and Widget Builder settings, then you can use the TinyURL extension in your custom chat widget.

UI Kits

• Enable it in the Dashboard settings, then you can use the TinyURL extension in your custom chat experience built with our UI Kits.

SDK

• Enable it in the Dashboard settings, then you can use the TinyURL extension in your custom chat experience built with our SDK.

---

Code

Once the Extension is enabled for your App and the settings are done, the recipients will receive metadata with the transcription details.

The transcription information is updated after the message is sent, so implement the onMessageEdited listener. See Edit message in the SDK docs.

Here is a sample response:

JSON

"@injected": {
  "extensions": {
    "voice-transcription": {
      "transcribed_message": "This is a test"
  }
}

If the voice-transcription key is missing, it means that either the extension is not enabled or has timed out.

Implementation

At the recipients’ end, from the message object, you can fetch the metadata by calling the getMetadata() method. Using this metadata, you can fetch the Rich Media Embed.

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("voice-transcription")
    ) {
      var voiceTranscriptionObject = extensionsObject["voice-transcription"];
      var transcribed_message = voiceTranscriptionObject["transcribed_message"];
    }
  }
}

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("voice-transcription")) {
          JSONObject transcriptionObject = extensionsObject.getJSONObject("voice-transcription");
        }
    }
}

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 != null && extensionsObject.has("voice-transcription")) {
     val transcriptionObject = extensionsObject.getJSONObject("voice-transcription")
   }
  }
 }
}

Swift

let textMessage = message as? TextMessage
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?["voice-transcription"] != nil {
        var transcriptionObject = extensionsObject?["voice-transcription"] as! [String :  Any]
      }
   }
}

Flutter

Map<String, dynamic>? metadata = message.metadata;
try {
  if (metadata != null) {
    Map? injectedObject = metadata["@injected"];

    if (injectedObject != null &&
        injectedObject.containsKey("extensions")) {
      Map extensionsObject = injectedObject["extensions"];

      if (extensionsObject.containsKey("voice-transcription")) {
        Map voiceTranscriptionObject =
            extensionsObject["voice-transcription"];

        List attachments = voiceTranscriptionObject['attachments'];

        for (var attachment in attachments) {
          if (attachment['error'] == null) {
            final attachmentData = attachment['data'];
            final transcribedMessage = attachmentData['transcribed_message'];
          }
        }
      }
    }
  }
} catch (e, stack) {
  debugPrint("$stack");
}