Read agent status

GET

/domains/{domain}/agents/{callqueue-agent-id}/status

Last modified:2026-10-20 19:58:38

OperationId:ReadAgentStatus

Returns an agent's current call center status, one value across every queue they are on, so a client can restore its status control after a reload.

Call Center Agent, Basic User, Advanced User, and Simple User read only their own status: use ~ as the agent. Site Manager reads agents who are users at its own site. Call Center Supervisor, Office Manager, Route Manager, Office Manager Read-Only, Reseller, Super User, and Super User Read Only read any agent in the domain (Reseller within its territory).

Three fields describe the status, because three names exist for one state: callqueue-agent-status is what the agent log stores (Auto), callqueue-agent-status-action is the action path to call to return to it (login), and callqueue-agent-status-label is what the portal shows (Online). Match your control on -action and show -label. User and agent reads also carry the stored value as callqueue-agent-state, but only an action on every queue (all) sets it. This read takes the agent's latest logged action, including a login or logout on one queue, and adds the action, label, and time. The user's status-message only carries an offline reason.

An agent who has never logged a status and is on no queue returns 404, as does an agent id that names another domain or a device address nobody owns.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The status.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//agents//status' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Online

{
    "domain": "example.com",
    "user": "1001",
    "callqueue-agent-id": "1001@example.com",
    "callqueue-agent-status": "Auto",
    "callqueue-agent-status-action": "login",
    "callqueue-agent-status-label": "Online",
    "callqueue-agent-status-since-datetime": "2026-09-01T14:30:00+00:00",
    "callqueue-agent-logged-in": "yes",
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-queue-count": 3
}

Modified at 2026-10-20 19:58:38

List agent summaries in call queue

Set agent offline