Skip to content
vocapable.Docs

The evaluation queue: calls to evaluate, AI reviews, disputes

GET
/v1/workspace/quality/queue
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/quality/queue \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualityQueue
object
calls
required
Calls
Array<object>
QualityCallToEvaluate
object
workspace_call_id
required
Workspace Call Id
string
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
direction
required
Direction
string
Allowed values: inbound outbound
queue_key
required
Any of:
string
ended_at
required
Ended At
string format: date-time
scorecard_ids
required
Scorecard Ids
Array<string>
ai_needs_review
required
Ai Needs Review
Array<object>
QualityEvaluationSummary
object
id
required
Id
string
scorecard_id
required
Scorecard Id
string
scorecard_name
required
Scorecard Name
string
scorecard_version
required
Scorecard Version
integer
call
required
QualityEvaluationCall
object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
direction
required
Direction
string
Allowed values: inbound outbound
queue_key
required
Any of:
string
call_at
required
Call At
string format: date-time
conversation_id
Any of:
string
channel
Channel
string
default: voice
Allowed values: voice sms
subject_kind
required
Subject Kind
string
Allowed values: person ai_agent
subject
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
score_source
required
Score Source
string
Allowed values: human ai
label
required
Label
string
evaluator
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
status
required
Status
string
Allowed values: draft submitted acknowledged completed needs_review reviewed
score
required
Any of:
number
raw_score
required
Any of:
number
auto_failed
required
Auto Failed
boolean
answered
required
Answered
integer
needs_review_count
required
Needs Review Count
integer
calibration_session_id
required
Any of:
string
reviews_evaluation_id
required
Any of:
string
submitted_at
required
Any of:
string format: date-time
ack_due_at
required
Any of:
string format: date-time
acknowledged_at
required
Any of:
string format: date-time
open_disputes
required
Open Disputes
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
drafts
required
Drafts
Array<object>
QualityEvaluationSummary
object
id
required
Id
string
scorecard_id
required
Scorecard Id
string
scorecard_name
required
Scorecard Name
string
scorecard_version
required
Scorecard Version
integer
call
required
QualityEvaluationCall
object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
direction
required
Direction
string
Allowed values: inbound outbound
queue_key
required
Any of:
string
call_at
required
Call At
string format: date-time
conversation_id
Any of:
string
channel
Channel
string
default: voice
Allowed values: voice sms
subject_kind
required
Subject Kind
string
Allowed values: person ai_agent
subject
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
score_source
required
Score Source
string
Allowed values: human ai
label
required
Label
string
evaluator
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
status
required
Status
string
Allowed values: draft submitted acknowledged completed needs_review reviewed
score
required
Any of:
number
raw_score
required
Any of:
number
auto_failed
required
Auto Failed
boolean
answered
required
Answered
integer
needs_review_count
required
Needs Review Count
integer
calibration_session_id
required
Any of:
string
reviews_evaluation_id
required
Any of:
string
submitted_at
required
Any of:
string format: date-time
ack_due_at
required
Any of:
string format: date-time
acknowledged_at
required
Any of:
string format: date-time
open_disputes
required
Open Disputes
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
open_disputes
required
Open Disputes
Array<object>
QualityDispute
object
id
required
Id
string
evaluation_id
required
Evaluation Id
string
question_key
required
Question Key
string
question_text
required
Question Text
string
raised_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
comment
required
Comment
string
status
required
Status
string
Allowed values: open upheld amended
due_at
required
Due At
string format: date-time
overdue
required
Overdue
boolean
resolver
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
resolution_comment
required
Any of:
string
before_value
required
Before Value
string
Allowed values: yes no na 1 2 3 4 5
after_value
required
Any of:
string
Allowed values: yes no na 1 2 3 4 5
before_score
required
Any of:
number
after_score
required
Any of:
number
resolved_at
required
Any of:
string format: date-time
can_resolve
required
Can Resolve
boolean
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
conversations
Conversations
Array<object>
QualityConversationToEvaluate

A routed text conversation an agent held and closed, not yet evaluated (CC8-R1).

object
conversation_id
required
Conversation Id
string
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
queue_key
required
Any of:
string
closed_at
required
Closed At
string format: date-time
disposition
required
Any of:
string
scorecard_ids
required
Scorecard Ids
Array<string>
Example
{
  "calls": [
    {
      "direction": "inbound"
    }
  ],
  "ai_needs_review": [
    {
      "call": {
        "direction": "inbound",
        "channel": "voice"
      },
      "subject_kind": "person",
      "score_source": "human",
      "status": "draft"
    }
  ],
  "drafts": [
    {
      "call": {
        "direction": "inbound",
        "channel": "voice"
      },
      "subject_kind": "person",
      "score_source": "human",
      "status": "draft"
    }
  ],
  "open_disputes": [
    {
      "status": "open",
      "before_value": "yes",
      "after_value": "yes"
    }
  ]
}