Your agent state, after-call work and next status

GET

/v1/workspace/me/agent-state

const url = 'https://api.vocapable.com/v1/workspace/me/agent-state';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

HTTPBearer

Responses

200

Successful Response

application/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
null

string

reason_label

required

Any of:

string
null

string

since

required

Any of:

string
null

string format: date-time

changed_by_user_id

Any of:

string
null

string

changed_by_name

Any of:

string
null

string

after_call_work

required

Any of:

AgentAfterCallWork
null

AgentAfterCallWork

object

call_id

required

Any of:

string
null

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
null

string

Allowed values: available not_ready offline

next_reason_code

required

Any of:

string
null

string

next_reason_label

required

Any of:

string
null

string

presence_revision

required

Any of:

integer
null

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
null

integer

max_duration_seconds

Any of:

integer
null

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
    }
  ]
}