Skip to content
vocapable.Docs

The call's transcript

GET
/v1/mobile/workspace/calls/{call_id}/transcript
curl --request GET \
  --url 'https://api.vocapable.com/v1/mobile/workspace/calls/example/transcript?after_seq=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
call_id
required
Call Id
string

Query Parameters

Section titled “Query Parameters”
after_seq
After Seq
integer
0 <= 1000000

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallTranscript

A conversation’s stored, redacted transcript (its transfer continuations included).

Poll with after_seq = the last next_after_seq for new turns; the live socket (POST …/transcript-token) streams the same turns plus partials.

object
call_id
required
Call Id
string
transcription
required
WorkspaceCallTranscription

What a person is told about a call’s transcript (PRD E7-R6, E6-R8).

label is the exact sentence the clients show (“Transcribing”, “Not recorded - made from a personal phone”, …) so the web console and the app use the same words.

object
status
Status
string
default: off
Allowed values: off live ended failed
untranscribed_reason
Any of:
string
Allowed values: personal_phone consent_off disclosure_not_played feature_off carrier_unavailable not_connected
label
Label
string
default: Not transcribed
turns
required
Turns
Array<object>
WorkspaceTranscriptTurn
object
id
required
Id
string
seq
required
Seq
integer
speaker
required
Speaker
string
Allowed values: rep customer
rep
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
started_at_ms
required
Started At Ms
integer
ended_at_ms
required
Ended At Ms
integer
text
required
Text
string
language
required
Any of:
string
next_after_seq
required
Next After Seq
integer
redaction
Redaction
string
default: pii_redacted
Allowed value: pii_redacted
gaps
Gaps
Array<object>
WorkspaceTranscriptGap

A span nothing was captured in (PRD CC8-R3: a payment pause). Shown between the turn after_seq and the next one as label (“[paused for payment]”).

object
kind
Kind
string
default: payment_pause
Allowed value: payment_pause
label
required
Label
string
after_seq
required
After Seq
integer
started_at_ms
required
Started At Ms
integer
ended_at_ms
required
Any of:
integer
Example
{
  "transcription": {
    "status": "off",
    "untranscribed_reason": "personal_phone",
    "label": "Not transcribed"
  },
  "turns": [
    {
      "speaker": "rep"
    }
  ],
  "redaction": "pii_redacted",
  "gaps": [
    {
      "kind": "payment_pause"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}