Get Punctuated Transcript
// Overview
Leveraging the unique interactionIdentifier provided upon successfully declaring the audio interaction, this endpoint enables you to instantly retrieve a detailed sentence-by-sentence transcript with precise timings, confidence scores, and speaker labels.
When this GET request successfully executes, an HTTP status will be returned to indicate the request was successful, along with a JSON response providing detailed transcription output.
If an error occurs when requesting to declare the interaction, a standard HTTP status will be retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in troubleshooting.
// Request Parameters & Code Examples
// Response Schema
Schema
Element | Type | Description |
sentenceSegments | array of objects | Ordered list of each sentence spoken, excluding redacted phrases |
sentenceSegments/participant | string | Speaker associated with sentence, will be either "participantOne" or "participantTwo" |
sentenceSegments/startTimeOffset | number | Start time of sentence (in milliseconds) |
sentenceSegments/endTimeOffset | number | End time of sentence (in milliseconds) |
sentenceSegments/phrase | string | Punctuated sentence, with any redacted segments represented by "# # # #" |
sentenceSegments/score | float | Confidence score |
redactionSegments | array of objects | List of details associated with each redacted segment |
redactionSegments/startTimeOffset | number | Start time of redacted phrase (in milliseconds) |
redactionSegments/endTimeOffset | number | End time of redacted phrase (in milliseconds) |
redactionSegments/result | string | Reason for redaction, will be "CVV", "Credit Card", or "Social Security" |
redactionSegments/score | float | Confidence score |