Skip to content
vocapable.Docs

Who listened to, coached or joined your call, and when (PRD E11-R3)

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
call_id
required
Call Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallSupervisionLog

Every supervision of one call, readable by the call’s rep and by managers/owners.

object
call_id
required
Call Id
string
active
required
Any of:
WorkspaceCallSupervision

A manager or owner listening to, whispering to or joined to a live call.

Shown to the REP on their own call (notice: “Priya is listening”) - supervision is never silent. ringing = the supervisor’s leg is connecting; joined = the carrier confirmed it is in the call.

object
id
required
Id
string
supervisor
required
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
mode
required
Mode
string
Allowed values: listen whisper barge
channel
required
Channel
string
Allowed values: app phone
state
required
State
string
Allowed values: requested ringing joined ended failed
notice
required
Notice
string
requested_at
required
Requested At
string format: date-time
joined_at
required
Any of:
string format: date-time
ended_at
required
Any of:
string format: date-time
end_reason
required
Any of:
string
revision
required
Revision
integer
events
required
Events
Array<object>
WorkspaceSupervisionEvent
object
id
required
Id
string
supervision_id
required
Supervision Id
string
kind
required
Kind
string
Allowed values: requested joined mode_changed ended failed
mode
required
Any of:
string
Allowed values: listen whisper barge
actor
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
label
required
Label
string
at
required
At
string format: date-time
Example
{
  "active": {
    "mode": "listen",
    "channel": "app",
    "state": "requested"
  },
  "events": [
    {
      "kind": "requested",
      "mode": "listen"
    }
  ]
}

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