Skip to content
vocapable.Docs

The call's transcript and summary beside the scorecard (audited)

POST
/v1/mobile/workspace/quality/call-context
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/workspace/quality/call-context \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "workspace_call_id": "example", "ai_call_id": "example", "conversation_id": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
QualityCallRefIn

What is evaluated: a person’s call (workspace_call_id), an AI agent’s call (ai_call_id) or a routed text conversation (conversation_id, CC8-R1).

object
workspace_call_id
Any of:
string
<= 64 characters
ai_call_id
Any of:
string
<= 64 characters
conversation_id
Any of:
string
<= 64 characters
Examplegenerated
{
  "workspace_call_id": "example",
  "ai_call_id": "example",
  "conversation_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualityCallContext

What the evaluator sees beside the scorecard: the transcript (with the turns any evidence cites), the AI summary, and whether a recording can be played (through the recording routes, whose every playback is audited). For a routed text conversation: its message thread and its close (disposition) instead.

object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
direction
required
Direction
string
Allowed values: inbound outbound
handler
required
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
subject_kind
required
Subject Kind
string
Allowed values: person ai_agent
call_at
required
Call At
string format: date-time
turns
required
Turns
Array<object>
QualityTranscriptTurn
object
seq
required
Seq
integer
speaker
required
Speaker
string
Allowed values: rep customer
started_at_ms
required
Started At Ms
integer
ended_at_ms
required
Ended At Ms
integer
text
required
Text
string
summary
required
Any of:
string
recording_available
required
Recording Available
boolean
scorecard_ids
required
Scorecard Ids
Array<string>
dialer
Any of:
QualityDialerOutcome

The outbound-dialer facts of a call the dialer placed (CC4): its campaign and the disposition the agent (or the dialer itself) recorded - context for the evaluator.

object
campaign_id
required
Campaign Id
string
campaign_name
required
Campaign Name
string
disposition
required
Any of:
string
disposition_label
required
Any of:
string
conversation_id
Any of:
string
channel
Channel
string
default: voice
Allowed values: voice sms
messages
Messages
Array<object>
QualityConversationMessage

One text of a routed conversation’s thread (redacted like a transcript turn).

object
id
required
Id
string
seq
required
Seq
integer
speaker
required
Speaker
string
Allowed values: rep customer
at
required
At
string format: date-time
at_ms
required
At Ms
integer
text
required
Text
string
author
required
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
conversation
Any of:
QualityConversationOutcome

How a routed text conversation ended (CC8-R1): the close disposition and note the agent recorded, who closed it and when - context beside the scorecard.

object
conversation_id
required
Conversation Id
string
queue_id
required
Queue Id
string
queue_name
required
Any of:
string
close_reason
required
Any of:
string
disposition
required
Any of:
string
close_note
required
Any of:
string
closed_by
required
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
closed_at
required
Any of:
string format: date-time
accepted_at
required
Any of:
string format: date-time
first_response_at
required
Any of:
string format: date-time
Example
{
  "direction": "inbound",
  "subject_kind": "person",
  "turns": [
    {
      "speaker": "rep"
    }
  ],
  "channel": "voice",
  "messages": [
    {
      "speaker": "rep"
    }
  ]
}

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": {}
    }
  ]
}