Skip to content
vocapable.Docs

Switch between listen, whisper and barge

PATCH
/v1/workspace/supervisions/{supervision_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/supervisions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "listen", "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
supervision_id
required
Supervision Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSupervisionModeChange
object
mode
required
Mode
string
Allowed values: listen whisper barge
expected_revision
required
Expected Revision
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceSupervisionSession

The supervisor’s own view of one supervision.

object
supervision
required
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
call_id
required
Call Id
string
rep
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
with_name
required
With Name
string
destination_hint
Any of:
string
Example
{
  "supervision": {
    "mode": "listen",
    "channel": "app",
    "state": "requested"
  }
}

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