Skip to content
vocapable.Docs

WFM on the phone: whether it is on, what you can do

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmOverview

The WFM landing: whether there is enough to start and what to do next.

object
settings
required
CcWfmSettings
object
revision
required
Revision
integer
shrinkage
required
Shrinkage
number
max_occupancy
required
Max Occupancy
number
grace_minutes
required
Grace Minutes
integer
history_weeks
required
History Weeks
integer
recency_decay
required
Recency Decay
number
max_shifts_per_week
required
Max Shifts Per Week
integer
timezone
required
Timezone
string
queues
required
Queues
Array<object>
CcWfmQueue

A queue (or a line answered without queues: line:<id>) WFM plans for, with the targets its requirement is sized to.

object
key
required
Key
string
name
required
Name
string
team_id
required
Any of:
string
sl_percent
required
Sl Percent
integer
sl_seconds
required
Sl Seconds
integer
asa_target_seconds
required
Any of:
integer
max_occupancy
required
Max Occupancy
number
shrinkage
required
Shrinkage
number
customized
required
Customized
boolean
revision
required
Revision
integer
history_days
required
History Days
integer
steps
required
Steps
Array<object>
CcWfmSetupStep

One “how to start” step (WFM views explain how to begin when nothing exists yet).

object
key
required
Key
string
Allowed values: history templates schedule publish
done
required
Done
boolean
title
required
Title
string
detail
required
Detail
string
templates
required
Templates
integer
draft_shifts
required
Draft Shifts
integer
published_shifts_upcoming
required
Published Shifts Upcoming
integer
pending_requests
required
Pending Requests
integer
caveats
required
Caveats
Array<string>
can_plan
required
Can Plan
boolean
can_configure
required
Can Configure
boolean
Example
{
  "steps": [
    {
      "key": "history"
    }
  ]
}