GuidesAPI ReferenceSDKsIntegrationsWhat's New?
Guides

Get started

Suggest Edits

This document describes how to get started with Insights UI. It covers generating an access token, processing conversations using Async API, and utilizing the Call Score and Insights features.

Before you begin

  • Before you can use the Insights UI, you must generate an access token. For more information, see Authenticate
  • The transcript needs to be at least 50 words or longer in order to qualify for Insights UI processing

Process conversations

Before using Insights UI, you need to process conversations using the available Async APIs. This step allows you to obtain a conversation ID for further analysis. You can use any of the following options.

When doing so, ensure that salesStage is set to qualification in the metadata section of the API request. This enables the Sales Process criteria in the Async API.

For additional Async API settings, see the API reference documentation.

Process a textual conversation

POST https://api.symbl.ai/v1/process/text

{
   "name": "Async Text API Production Test",
   "features": 
{
        "featureList": ["insights", "callScore"]
       },
   "metadata": 
{
        "salesStage": "qualification",
        "prospectName": "Tester"
       }
}

Process an audio URL

POST https://api.symbl.ai/v1/process/audio/url

{
    "url": "https://storage.googleapis.com/sales-intelligence-call-recordings/Realtor_Sales_Call_Youtube_12min.mp3",
    "enableSpeakerDiarization": true,
    "diarizationSpeakerCount": 2,
    "name": "Async Audio URL API Production Test",
    "features": {
        "featureList": ["insights", "callScore"]
    },
    "metadata": {
        "salesStage": "qualification",
        "prospectName": "Limited"
    }
}

Process a video URL

POST https://api.symbl.ai/v1/process/video/url

{
    "url": "https://storage.googleapis.com/sales-intelligence-call-recordings/GMT20221213-165025_Recording_640x360.mp4",
    "enableSpeakerDiarization": true,
    "diarizationSpeakerCount": 2,
    "name": "Async Video URL API Production Test",
    "startTime": "2023-04-20T17:26:12",
    "features": {
        "featureList": ["insights", "callScore"]
    },
    "metadata": {
        "salesStage": "qualification",
        "prospectName": "Moon Limited"
    }
}

Process an audio file

POST https://api.symbl.ai/v1/process/audio 

https://api.symbl.ai/v1/process/audio?name="Async API Production Audio File Test"&features={"featureList":["callScore", "insights"]}&metadata={"salesStage":"General","prospectName":"Audio File LLC"}

Process a video file

POST https://api.symbl.ai/v1/process/video 

https://api.symbl.ai/v1/process/video?name="Async API Production Video File Test"&features={"featureList":["callScore", "insights"]}&metadata={"salesStage":"General","prospectName":"Audio File LLC"}

Note: Make sure to include the following parameters in the request body: name, startTime, features (including insights and callScore), and metadata (such as callStage and prospectName). The startTime attribute is shown on the Insights UI cards in the list page.

Process a conversation using Streaming API

You can process a real-time conversation using Streaming API and generate Insights UI once the stream is complete. To get Insights UI after the streaming session is completed, add generate Insights UI action in the streaming API start request.

{
    type: "start_request",
    actions: [
                {
                    name: 'generateInsightsUI',
                    parameters: {
                        prospectName: "ABC Inc"
                    }
                }
            ]
}

Verify Call Score and Insights jobs

After processing conversations, you can verify the status of the Call Score and Insights jobs using the following API endpoints:

GET /v1/conversations/{conversationId}/callscore/status
GET /v1/conversations/{conversationId}/lm-insights/status

Replace {conversationId} with the conversation ID obtained in the previous step. Check the response to see if the job status is processing or completed.

{
    "jobId": "12b8d4d8-1f14-484f-806f-aa75b173cd9f",
    "status": "completed"
}

Generate the Insights UI List page

To generate the Insights UI List page, follow these steps:

Make a GET request to the following endpoint, providing the includeCallScore (true/false) as query parameter:

GET https://api.symbl.ai/v1/conversations/experiences/insights/list?includeCallScore=true

Include your access token in the Authorization header.

To control the visibility of the call score component, use the query parameter includeCallScore=\<true/false> on the URL that you got back in the response.

You will receive a response containing the URL for the Insights UI List Page. Access this URL to view the list of conversations.

{
   "url": "<list_view_url>"
}

Example:
{
   "url": "https://insights-ui.symbl.ai?o=655c1b339382a754a0b9af3fdcc11cbde6a434e7779ff5e3327a521f0506bff0b485d67d80865d7d0794845c2104246efa283ff41fb176db5768799f0e00d71b12e89a7d3d9314c5580bc79fb2eea87d8e7cb6a8bdb049c23df1f6544d2824c67fd18eb25439444c1b1155d7a3bbefa1b128dfda311406ceb609abae5ed076fcfccfc603d89771fb2ed22ccfe4447287eed60615d5f5266a00eded47d13ff92860f3a14e8c687006766d8d3351e7ea41de3ab2e2894acca6b6eb61d9e6b9ba1e0924c58786992191bb2dabe8e6135c4e84caee26addb60a7f4ff5218c4ec71e87c6d2301d11600497f80e099b0ad326ebe22156e2633ac91d36719796a82675146519d32732cd79b8ab19ee9f7f3208363ca71ab4498cf5d&conversationType=sales&includeCallScore=true"
}

Generate Insights UI Details page

To generate the Insights UI Details page for a specific conversation, follow these steps:

Make a GET request to the following endpoint, replacing {conversationId} with you conversation ID.

GET /v1/conversations/experiences/insights/details/{conversationId}

Include your access token in the Authorization header.

You will receive a response containing the URL for the Insights UI Details Page. Access this URL to view the detailed insights for the conversation.

{
   "url": ""
}

Example
{
   "url": "https://insights-ui.symbl.ai/meeting-details/4899721212592128?o=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik4wTTFRME0yTlVVelJEWXhNREF5T0Rrd01qZ3lOa1kwUXpaRVFUVXhRa1U0TmtVeVF6a3lOdyJ9.eyJodHRwczovL3BsYXRmb3JtLnN5bWJsLmFpL3VzZXJJZCI6IjUzNDMwNzk1NTI3NzgyNDAiLCJpc3MiOiJodHRwczovL3JhbW1lcmFpLmF1dGgwLmNvbS8iLCJzdWIiOiIzZGtHUE9yN2dtTnJHWno4Q29FOVJ3WVJyWXVFaGxEeUBjbGllbnRzIiwiYXVkIjoicmFtbWVyLWNvbW1vbiIsImlhdCI6MTY4ODk2NDQ1NSwiZXhwIjoxNjg5MDUwODU1LCJhenAiOiIzZGtHUE9yN2dtTnJHWno4Q29FOVJ3WVJyWXVFaGxEeSIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyJ9.qxJ9RD1AZGqxWz5beSzMmFhJhzzUMZrRKBc0Xpw5EQc5LujA1TfP_91AKBiHplyBkeRqeqTXvuChaB3MR-KLhV58AC-XhA_JWpm6SpEQs4BcT41eAS50Wj6cvQZmoyXZCd5i0H9gVRK_6ffi837nrMF6zM74fhLhGJT7I0VdWvK-swWRW0Dq9sXzHRkDC_aOhMHxFrHx3Qk_eKIqxUQshLRV9b-STHid0YbffXoxVJbOa4pEence8_W0yW-HoA0Tcq4VBIrU1EJpcDSliuI52gFRwIor9NMlEr6uYhhXnJk5yS507UFANeBUS9GWGUK1WQAJz5VbKKwv0vU2Ta1fTg&conversationType=general&includeCallScore=false
"
}

If you have any further questions or need assistance, contact our support team at [email protected].

Updated 4 months ago