Log agent in

PATCH

/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}/login

Last modified:2026-10-09 00:26:58

OperationId:AgentLogin

Logs an agent in to one call queue, or to every queue they are on with all: the agent's availability becomes automatic and calls are dispatched to them. The agent log records Auto, shown as Online.

Call Center Agent, Basic User, Advanced User, and Simple User act only on their own agent entries: use ~ as the agent. Site Manager acts on agents who are users at its own site; on a named queue, the queue must be at its site too. Call Center Supervisor, Office Manager, Route Manager, Reseller, and Super User act on any agent in the domain. Office Manager Read-Only and Super User Read Only get 403.

202 means the change was published over the service bus (SBUS), not yet applied. The action is also written to the agent log, which GET /domains/{domain}/agents/{callqueue-agent-id}/status reads back. PUT on this path does the same as PATCH; other methods return 405. The request has no body. Logging in clears the user's status-message.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢202Accepted

application/json

The change was published over the service bus (SBUS) and is applied shortly after: {"code": 202, "message": "Accepted"}.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//callqueues/all/agents//login' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-09 00:26:58

Set agent offline

Log agent out