Skip to content
vocapable.Docs

Interval forecast and Erlang C staffing per queue x day

GET
/v1/workspace/contact-center/wfm/forecast
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/contact-center/wfm/forecast?days=7&coverage=false&channel=voice' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
queue
Any of:
Array<string>
<= 50 items
start
Any of:
string format: date
days
Days
integer
default: 7 >= 1 <= 14
coverage
Coverage
boolean
team
Any of:
string
<= 96 characters
channel
Channel
string
default: voice
Allowed values: voice sms

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmForecast
object
days
required
Days
Array<object>
CcWfmForecastDay
object
queue_key
required
Queue Key
string
channel
required
Channel
string
day
required
Day
string format: date
status
required
Status
string
Allowed values: ok insufficient_history closed
history_days
required
History Days
integer
sample_days
required
Sample Days
Array<string>
multiplier
required
Multiplier
number
total_volume
required
Total Volume
number
peak_required
required
Peak Required
integer
stored
required
Stored
boolean
generated_at
required
Any of:
string format: date-time
intervals
required
Intervals
Array<object>
CcWfmForecastInterval
object
interval_start
required
Interval Start
string format: date-time
volume
required
Volume
number
aht_seconds
required
Any of:
number
erlangs
required
Erlangs
number
required
required
Required
integer
required_scheduled
required
Required Scheduled
integer
service_level
required
Any of:
number
asa_seconds
required
Any of:
number
occupancy
required
Any of:
number
binding
required
Binding
string
Allowed values: none service_level asa occupancy capped
overridden
required
Overridden
boolean
scheduled_heads
Any of:
integer
scheduled_on_queue
Any of:
integer
totals
required
Totals
Array<object>
CcWfmForecastInterval
object
interval_start
required
Interval Start
string format: date-time
volume
required
Volume
number
aht_seconds
required
Any of:
number
erlangs
required
Erlangs
number
required
required
Required
integer
required_scheduled
required
Required Scheduled
integer
service_level
required
Any of:
number
asa_seconds
required
Any of:
number
occupancy
required
Any of:
number
binding
required
Binding
string
Allowed values: none service_level asa occupancy capped
overridden
required
Overridden
boolean
scheduled_heads
Any of:
integer
scheduled_on_queue
Any of:
integer
caveats
required
Caveats
Array<string>
Example
{
  "days": [
    {
      "status": "ok",
      "intervals": [
        {
          "binding": "none"
        }
      ]
    }
  ],
  "totals": [
    {
      "binding": "none"
    }
  ]
}

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