Skip to content
vocapable.Docs

Active and recent alerts you can see

GET
/v1/workspace/contact-center/alerts
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/contact-center/alerts?active_only=true&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
active_only
Active Only
boolean
default: true
limit
Limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcAlerts
object
data
required
Data
Array<object>
CcActiveAlert
object
id
required
Id
string
rule_id
required
Rule Id
string
kind
required
Kind
string
Allowed values: service_level longest_wait calls_waiting available_agents abandon_rate agent_state_duration adherence
queue_key
required
Any of:
string
queue_name
required
Any of:
string
subject_user_id
required
Any of:
string
subject_name
required
Any of:
string
value
required
Any of:
number
threshold
required
Threshold
number
fired_at
required
Fired At
string format: date-time
cleared_at
required
Any of:
string format: date-time
message
required
Message
string
Example
{
  "data": [
    {
      "kind": "service_level"
    }
  ]
}

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