Get SDK
API Docs by APIMATIC

Agents Status
#

Agents Status
#

Returns the user list with relevant email, extension, and current status.

GET /api/v1/{api_key}/agents_status.json

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Template

Contact center API key

Responses

  • 200
  • 403
  • 415
  • 503

Success

application/json

Type

array<Success Agent Status Response>

[
  {
    "email": "pt@fg.com",
    "ext": "7777",
    "status": "available"
  },
  {
    "email": "px@fg.com",
    "ext": "5555",
    "status": "unavailable"
  }
]
  • Request
  • Response
curl -X GET \
  --url 'https://www.example.com/api/v1/ZXTf40WQMcQQJHZKGMhHL8av1AxxxVHy/agents_status.json' \
  -H 'Accept: application/json'