Agent Status API

The Agent Status API tells you whether a Kixie agent is logged in and whether they are currently on a call. Use it to drive wallboards, routing decisions or availability displays in your own systems.

Before You Start

• Your account must be on the Professional billing tier or above.
• Your API key must be activated. See Kixie API Authentication.

Endpoint

GET https://apig.kixie.com/www/agent/status?apiKey=[API KEY]&email=[agent email address]

Note the capital K in apiKey. This endpoint uses apiKey, while the event endpoints such as Make a Call use all-lower-case apikey. Copying a parameter name between the two is a common cause of a request failing for no obvious reason.

This endpoint also uses a different base path, /www/agent/status, rather than the /app/event path used by the event endpoints.

Responses

Logged in, not on a call

{
  "success": true,
  "result": {
    "onCall": 0,
    "registered": 1,
    "device": "Customer Device ID"
  }
}

Logged in, on a call

{
  "success": true,
  "result": {
    "onCall": 1,
    "registered": 1,
    "device": "Customer Device ID"
  }
}

Not logged in, offline

{
  "success": false,
  "result": {
    "onCall": 0,
    "registered": 0,
    "device": "Customer Device ID"
  }
}

Reading the Response

• registered — 1 when the agent's device is connected to Kixie, 0 when it is not. This is the field to check for "is this agent available".
• onCall — 1 when the agent is on a live call.
• device — the identifier of the device the agent is registered on.

Watch the success field. It is false when the agent is offline. That is a successful request reporting an offline agent, not a failed request. If your integration treats success: false as an error it will log failures every time someone signs out for the day. Check registered to determine availability, and treat a non-200 response or a missing body as the real error case.

Other Ways This Shows Up

Developers look for this as agent status, agent availability, is an agent online, presence API, checking whether a rep is on a call, or building a wallboard.