Receive live topics

This example describes how you can use the Streaming API to receive Topics, which are what the algorithm determines to be the most important keywords or phrases used in a conversation. This example uses both the JavaScript SDK, which is meant to be run using Node.js, and native JavaScript which runs in the browser:


The first thing we do is connect to the Web Socket. If you're using the SDK you can use onTopicResponse handler after the connection is established, otherwise you'll have to parse the response in the onmessage callback for the WebSocket.


const {sdk} = require('symbl-node');
const uuid = require('uuid').v4;

(async () => {
  try {
    // Initialize the SDK. You can find the appId and appSecret at
    await sdk.init({
      appId: appId,
      appSecret: appSecret,
      basePath: '',

    // Need unique Id
    const id = uuid()

    // Start Real-time Request (Uses Real-time WebSocket API behind the scenes)
    const connection = await sdk.startRealtimeRequest({
      insightTypes: ['action_item', 'question'],
      config: {
        meetingTitle: 'My Test Meeting',
        confidenceThreshold: 0.7,
        timezoneOffset: 480, // Offset in minutes from UTC
        languageCode: 'en-US',
        sampleRateHertz: 44100,
      speaker: {
        // Optional, if not specified, will simply not send an email in the end.
        userId: 'emailAddress', // Update with valid email
        name: 'My name'
      handlers: {
         * When Symbl detects a topic, this callback will be called.
        onTopicResponse: (data) => {
          console.log('onTopicResponse', JSON.stringify(data, null, 2));
          // The topic is found in data.phrase.
          console.log('Topic:', data.phrase);
  } catch (e) {

Connect Mic

After you connect, you want to connect to your device's microphone. This code is inserted after the connection and before the closing of the try...catch

const micInputStream = micInstance.getAudioStream()
/** Raw audio stream */
micInputStream.on('data', (data) => {
  // Push audio from Microphone to websocket connection

micInputStream.on('error', function (err) {
  console.log('Error in Input Stream: ' + err)

micInputStream.on('startComplete', function () {
  console.log('Started listening to Microphone.')

micInputStream.on('silence', function () {
  console.log('Got SIGNAL silence')


setTimeout(async () => {
  // Stop listening to microphone
  console.log('Stopped listening to Microphone.')
  try {
    // Stop connection
    await connection.stop()
    console.log('Connection Stopped.')
  } catch (e) {
    console.error('Error while stopping the connection.', e)
}, 60 * 1000) // Stop connection after 1 minute i.e. 60 secs


Create a JavaScript file named app.js and copy this code into the file. Fill in the placeholder values with the proper values. Use NPM to install the required libraries: npm install symbl-node uuid.

In a terminal window, run:

$ node app.js

Check the console for a success message.

Native JavaScript

const accessToken = accessToken;
// Refer to the Authentication section for how to generate the accessToken:
const uuid = require('uuid').v4;
const connectionId = uuid();
const symblEndpoint = `wss://${connectionId}?access_token=${accessToken}`;
const ws = new WebSocket(symblEndpoint);

ws.onmessage = (event) => {
  // You can find the conversationId in;
  const data = JSON.parse(;
  if (data.type === 'message' && data.message.hasOwnProperty('data')) {
  if (data.type === 'topic_response') {
    for (let topic of data.topics) {
      console.log('topic:', topic.phrases)
  console.log('event', event);
  console.log('Parsed Object', JSON.stringify(data, null, 2));

// Fired when the WebSocket closes unexpectedly due to an error or lost connetion
ws.onerror  = (err) => {

// Fired when the WebSocket connection has been closed
ws.onclose = (event) => {'Connection to websocket closed');

// Fired when the connection succeeds.
ws.onopen = (event) => {
    type: 'start_request',
    meetingTitle: 'Websockets How-to', // Conversation name
    insightTypes: ['question', 'action_item'], // Will enable insight generation
    config: {
      confidenceThreshold: 0.5,
      languageCode: 'en-US',
      speechRecognition: {
        encoding: 'LINEAR16',
        sampleRateHertz: 44100,
    speaker: {
      userId: '[email protected]',
      name: 'Example Sample',


Backward Compatibility

The previous endpoint wss:// is now updated to wss:// to standardize our API nomenclature. This change is backward compatible. However, we recommend you to use the new endpoint.

Connect Mic

After you connect, you want to connect to your device's microphone. This code is inserted after the ws.onopen function:

const stream = await navigator.mediaDevices.getUserMedia({ audio: true, video: false });

 * The callback function which fires after a user gives the browser permission to use
 * the computer's microphone. Starts a recording session which sends the audio stream to
 * the WebSocket endpoint for processing.
const handleSuccess = (stream) => {
  const AudioContext = window.AudioContext;
  const context = new AudioContext();
  const source = context.createMediaStreamSource(stream);
  const processor = context.createScriptProcessor(1024, 1, 1);
  const gainNode = context.createGain();
  processor.onaudioprocess = (e) => {
    // convert to 16-bit payload
    const inputData = e.inputBuffer.getChannelData(0) || new Float32Array(this.bufferSize);
    const targetBuffer = new Int16Array(inputData.length);
    for (let index = inputData.length; index > 0; index--) {
        targetBuffer[index] = 32767 * Math.min(1, inputData[index]);
    // Send audio stream to websocket.
    if (ws.readyState === WebSocket.OPEN) {



Open up your browser's development environment and copy this code into the console. Replace the placeholder values with the proper values.

If successful you should receive a response in the console.

Handlers Reference

  • handlers: This object has the callback functions for different events

    • onTopicResponse: This callback provides you with any of the detected topics in real-time as they are detected. As with the onMessageResponse this would also return every topic in case of multiple streams.

    onTopicResponse JSON Response Example

      "id": "e69a5556-6729-11eb-ab14-2aee2deabb1b",
      "messageReferences": [{
        "id": "0df44422-0248-47e9-8814-e87f63404f2c",
        "relation": "text instance"
      "phrases": "auto insurance",
      "rootWords": [{
        "text": "auto"
      "score": 0.9,
      "type": "topic"

See Also