Skip to content
vocapable.Docs

Turn auto-answer on or off for yourself

PUT
/v1/workspace/me/agent-preferences
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/me/agent-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "auto_answer": true, "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentPreferencesUpdate
object
auto_answer
required
Auto Answer
boolean
expected_revision
required
Expected Revision
integer
>= 1
Examplegenerated
{
  "auto_answer": true,
  "expected_revision": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentStateView
object
user_id
required
User Id
string
state
required
State
string
Allowed values: available reserved on_call after_call_work not_ready offline
reason_code
required
Any of:
string
reason_label
required
Any of:
string
since
required
Any of:
string format: date-time
changed_by_user_id
Any of:
string
changed_by_name
Any of:
string
after_call_work
required
Any of:
AgentAfterCallWork
object
call_id
required
Any of:
string
started_at
required
Started At
string format: date-time
until
required
Until
string format: date-time
seconds_remaining
required
Seconds Remaining
integer
extensions_used
required
Extensions Used
integer
extensions_allowed
required
Extensions Allowed
integer
extend_seconds
required
Extend Seconds
integer
next_state
required
Any of:
string
Allowed values: available not_ready offline
next_reason_code
required
Any of:
string
next_reason_label
required
Any of:
string
presence_revision
required
Any of:
integer
contact_center_enabled
required
Contact Center Enabled
boolean
auto_answer
required
Auto Answer
boolean
auto_answer_preference
required
Auto Answer Preference
boolean
auto_answer_allowed
required
Auto Answer Allowed
boolean
preferences_revision
required
Preferences Revision
integer
reason_codes
required
Reason Codes
Array<object>
AgentReasonCode
object
code
required
Code
string
label
required
Label
string
builtin
required
Builtin
boolean
archived
Archived
boolean
revision
Any of:
integer
max_duration_seconds
Any of:
integer
paid
Paid
boolean
default: true
generated_at
required
Generated At
string format: date-time
poll_seconds
required
Poll Seconds
integer
Example
{
  "state": "available",
  "next_state": "available",
  "reason_codes": [
    {
      "archived": false,
      "paid": true
    }
  ]
}

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