Get a presence summary

The GET /agents-availability endpoint returns a presence summary which contains the current number of agents with the skill or skills you specify in each of the presence categories: Ready, Away, Extended Away, Logged Out.

In this page

Headers

Header parameters in Requests (Agent Availability API) apply to this endpoint.

Authorization scopes supported:

Scope	Access granted

Scope	Access granted
`agents-availability:read`	Entire endpoint

Parameters

The endpoint accepts the following query string parameter:

skillName

Type	Required	Example

Type	Required	Example
String	True	`skillName1, skillName2, ...`

A comma-delimited list of skills that agents must be tagged with to be included in the response.

Requests

Request a presence summary for an interaction with the Service skill

curl -L -X GET "https://***.api.newvoicemedia.com/agents-availability?skillNames=Service" 
-H "Accept: application/vnd.newvoicemedia.v1+json" 
-H "Authorization: <ACCESS_TOKEN>"

Request a presence summary for an interaction with the Service and Sales skills

curl -L -X GET "https://****.api.newvoicemedia.com/agents-availability?skillNames=Service,Sales" 
-H "Accept: application/vnd.newvoicemedia.v1+json" 
-H "Authorization: <ACCESS_TOKEN>"

Responses

A response to a valid GET /agents-availability request contains a presence summary.

{
    "Ready": 10,
    "Away": 3,
    "Extended Away": 0,
    "Logged Out": 0
}