Read Agent Current Status

GET

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

Last modified:2026-09-11 17:54:11

OperationId:ReadAgentStatus

The agent's current call center status, as one object. This is the read side of the agent action endpoints in this folder, which could set a status but never report one back.

Read the status here, not off the user. A user's status-message only carries a reason (Break, Lunch, a custom label). Agent Login, Agent Logout, Agent Single Call and the manual action all clear it, so End shift, single call mode and plain offline are one empty string there. The agent log keeps them apart, and that is what this endpoint reads.

callqueue-agent-status is the same token the action endpoints accept, so a client restoring a status dropdown after a page reload can match it directly with no reverse lookup. Custom statuses stay cust1-cust8; their per-domain display text comes back separately as callqueue-agent-status-label.

Not queue-scoped: an agent's status is one value across every queue they are on.

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

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/agents/{{callqueue-agent-id}}/status' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "domain": "example.com",
    "user": "2050",
    "callqueue-agent-id": "sip:2050@example.com",
    "callqueue-agent-status": "cust1",
    "callqueue-agent-status-label": "WFH",
    "callqueue-agent-status-since-datetime": "2026-09-09T14:22:03+00:00",
    "callqueue-agent-logged-in": "yes",
    "callqueue-agent-availability-type": "manual",
    "callqueue-agent-queue-count": 3
}

Modified at 2026-09-11 17:54:11

List Call Queue Agents

Agent Login