Choose your status for when this call ends

PUT

/v1/workspace/me/agent-state/next

curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/me/agent-state/next \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "next_state": "available", "reason_code": "example", "expected_revision": 1 }'

Authorizations

• HTTPBearer

Request Body^required

Media typeapplication/json

AgentNextStateUpdate

Choose (or with next_state: null clear) the status after this call.

object

next_state

required

Any of:

string

string

Allowed values: available not_ready offline

null

null

reason_code

Any of:

string

string

>= 1 characters <= 40 characters

null

null

expected_revision

required

Expected Revision

integer

>= 1

Responses

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

string

null

null

reason_label

required

Any of:

string

string

null

null

since

required

Any of:

string

string format: date-time

null

null

changed_by_user_id

Any of:

string

string

null

null

changed_by_name

Any of:

string

string

null

null

after_call_work

required

Any of:

AgentAfterCallWork

AgentAfterCallWork

object

call_id

required

Any of:

string

string

null

null

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

null

null

next_state

required

Any of:

string

string

Allowed values: available not_ready offline

null

null

next_reason_code

required

Any of:

string

string

null

null

next_reason_label

required

Any of:

string

string

null

null

presence_revision

required

Any of:

integer

integer

null

null

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

integer

null

null

max_duration_seconds

Any of:

integer

integer

null

null

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

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}