{
  "transcriptionId": "b1e7c9a4-3f2d-4a6b-9c8e-1d2f3a4b5c6d",
  "callId": "abc123def456ghi789",
  "tenantId": 24,
  "peerName": "OIVR_24_1001",
  "direction": "inbound",
  "tag": "Support",
  "start": "2024-08-21T13:10:00-05:00",
  "end": "2024-08-21T13:12:00-05:00",
  "durationSec": 120,
  "participants": [
    {
      "index": 0,
      "cidNum": "1001",
      "cidName": "Jane Doe"
    },
    {
      "index": 1,
      "cidNum": "5555555555",
      "cidName": "Frederick Durst"
    }
  ],
  "transcript": [
    {
      "channel": 0,
      "text": "Thanks for calling ACME, how can I help you today?",
      "start": "0.5",
      "cidNum": "1001",
      "cidName": "Jane Doe"
    },
    {
      "channel": 1,
      "text": "Hi, I need to reset the password on my account.",
      "start": "3.2",
      "cidNum": "5555555555",
      "cidName": "Frederick Durst"
    }
  ],
  "insights": {
    "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
    "metadata": {
      "request_id": "1cf00c0a-9d1f-49a5-83e6-d5b7f0b0f6a1",
      "created": "2024-08-21T18:12:03.123Z",
      "language": "en",
      "intents_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 8
      },
      "sentiment_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 8
      },
      "summary_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 21
      },
      "topics_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 6
      }
    },
    "results": {
      "summary": {
        "text": "The caller contacted ACME support to reset the password on their account."
      },
      "sentiments": {
        "segments": [
          {
            "text": "Thanks for calling ACME, how can I help you today?",
            "start_word": 0,
            "end_word": 9,
            "sentiment": "positive",
            "sentiment_score": 0.62
          },
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "sentiment": "neutral",
            "sentiment_score": 0.08
          }
        ],
        "average": {
          "sentiment": "neutral",
          "sentiment_score": 0.35
        }
      },
      "topics": {
        "segments": [
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "topics": [
              {
                "topic": "Account access",
                "confidence_score": 0.91
              }
            ]
          }
        ]
      },
      "intents": {
        "segments": [
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "intents": [
              {
                "intent": "Reset password",
                "confidence_score": 0.88
              }
            ]
          }
        ]
      }
    }
  }
}

API Reference

Transcription end

This webhook fires when a transcribed call’s transcription session ends. It delivers the full conversation transcript along with an insights object of AI-generated analysis (summary, sentiment, topics, and intents) produced from the transcript.

A tenant opts in by configuring a webhook with the type TRANSCRIPTIONEND. The event only fires for calls that were transcribed. If the transcript is empty or analysis could not be produced, insights is an empty object ({}).

WEBHOOK

TRANSCRIPTIONEND

{
  "transcriptionId": "b1e7c9a4-3f2d-4a6b-9c8e-1d2f3a4b5c6d",
  "callId": "abc123def456ghi789",
  "tenantId": 24,
  "peerName": "OIVR_24_1001",
  "direction": "inbound",
  "tag": "Support",
  "start": "2024-08-21T13:10:00-05:00",
  "end": "2024-08-21T13:12:00-05:00",
  "durationSec": 120,
  "participants": [
    {
      "index": 0,
      "cidNum": "1001",
      "cidName": "Jane Doe"
    },
    {
      "index": 1,
      "cidNum": "5555555555",
      "cidName": "Frederick Durst"
    }
  ],
  "transcript": [
    {
      "channel": 0,
      "text": "Thanks for calling ACME, how can I help you today?",
      "start": "0.5",
      "cidNum": "1001",
      "cidName": "Jane Doe"
    },
    {
      "channel": 1,
      "text": "Hi, I need to reset the password on my account.",
      "start": "3.2",
      "cidNum": "5555555555",
      "cidName": "Frederick Durst"
    }
  ],
  "insights": {
    "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
    "metadata": {
      "request_id": "1cf00c0a-9d1f-49a5-83e6-d5b7f0b0f6a1",
      "created": "2024-08-21T18:12:03.123Z",
      "language": "en",
      "intents_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 8
      },
      "sentiment_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 8
      },
      "summary_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 21
      },
      "topics_info": {
        "model_uuid": "80ab3179-d113-4254-bd6b-4a2f96498695",
        "input_tokens": 42,
        "output_tokens": 6
      }
    },
    "results": {
      "summary": {
        "text": "The caller contacted ACME support to reset the password on their account."
      },
      "sentiments": {
        "segments": [
          {
            "text": "Thanks for calling ACME, how can I help you today?",
            "start_word": 0,
            "end_word": 9,
            "sentiment": "positive",
            "sentiment_score": 0.62
          },
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "sentiment": "neutral",
            "sentiment_score": 0.08
          }
        ],
        "average": {
          "sentiment": "neutral",
          "sentiment_score": 0.35
        }
      },
      "topics": {
        "segments": [
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "topics": [
              {
                "topic": "Account access",
                "confidence_score": 0.91
              }
            ]
          }
        ]
      },
      "intents": {
        "segments": [
          {
            "text": "Hi, I need to reset the password on my account.",
            "start_word": 10,
            "end_word": 19,
            "intents": [
              {
                "intent": "Reset password",
                "confidence_score": 0.88
              }
            ]
          }
        ]
      }
    }
  }
}

Body

application/json

transcriptionId

string

Unique identifier for the transcription session.

callId

string

Identifier of the call that was transcribed.

tenantId

integer

Your VOXO tenant/account identifier.

peerName

string

Internal peer name of the primary channel.

direction

string | null

Call direction, for example inbound or outbound.

tag

string | null

Optional tag associated with the call.

start

string<date-time> | null

ISO 8601 timestamp when the transcription session started.

end

string<date-time>

ISO 8601 timestamp when the transcription session ended.

durationSec

integer | null

Duration of the transcription session in seconds.

participants

object[]

The channels that were transcribed in this session.

Show child attributes

transcript

object[]

Ordered transcript segments captured during the call. Only finalized turns are included — interim (partial) speech results are excluded, so each completed turn appears once.

Show child attributes

insights

object

AI-generated analysis of the transcript (Deepgram Text Intelligence). Empty object ({}) when no analysis was produced.

Show child attributes

Response

200

200 OK

Call recording

⌘I

Getting started

API

Webhooks

Transcription end

Body

Response