Skip to content
vocapable.Docs

Real-time adherence and conformance

GET
/v1/workspace/contact-center/wfm/adherence
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/adherence \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
day
Any of:
string format: date
team
Any of:
string
<= 96 characters
user
Any of:
string
<= 96 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmAdherence
object
day
required
Day
string format: date
timezone
required
Timezone
string
grace_minutes
required
Grace Minutes
integer
computed_at
required
Computed At
string format: date-time
poll_seconds
required
Poll Seconds
integer
agents
required
Agents
Array<object>
CcWfmAgentAdherence
object
user_id
required
User Id
string
name
required
Name
string
scheduled_minutes
required
Scheduled Minutes
number
adherent_minutes
required
Adherent Minutes
number
adherence
required
Any of:
number
conformance
required
Any of:
number
in_adherence_now
required
Any of:
boolean
scheduled_now
required
Any of:
CcWfmSegment
object
kind
required
Kind
string
Allowed values: work break lunch meeting training coaching custom time_off
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
reason_code
required
Any of:
string
label
required
Label
string
state_now
required
Any of:
CcWfmStateSpan
object
state
required
State
string
Allowed values: available reserved on_call after_call_work not_ready offline
reason_code
required
Any of:
string
label
required
Label
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
exceptions
required
Exceptions
Array<object>
CcWfmAdherenceException
object
user_id
required
User Id
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
minutes
required
Minutes
number
scheduled
required
Scheduled
string
Allowed values: work break lunch meeting training coaching custom time_off
scheduled_label
required
Scheduled Label
string
actual_state
required
Actual State
string
Allowed values: available reserved on_call after_call_work not_ready offline
actual_label
required
Actual Label
string
ongoing
required
Ongoing
boolean
excused
required
Excused
boolean
segments
Any of:
Array<object>
CcWfmSegment
object
kind
required
Kind
string
Allowed values: work break lunch meeting training coaching custom time_off
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
reason_code
required
Any of:
string
label
required
Label
string
spans
Any of:
Array<object>
CcWfmStateSpan
object
state
required
State
string
Allowed values: available reserved on_call after_call_work not_ready offline
reason_code
required
Any of:
string
label
required
Label
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
out_of_adherence_now
required
Out Of Adherence Now
integer
adherence
required
Any of:
number
conformance
required
Any of:
number
Example
{
  "agents": [
    {
      "scheduled_now": {
        "kind": "work"
      },
      "state_now": {
        "state": "available"
      },
      "exceptions": [
        {
          "scheduled": "work",
          "actual_state": "available"
        }
      ],
      "segments": [
        {
          "kind": "work"
        }
      ],
      "spans": [
        {
          "state": "available"
        }
      ]
    }
  ]
}

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