NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Call Center/Agent Actions → Agent Set Offline Status

AI-generated

Summary

Sets the offline status of a NetSapiens call‑center agent.

Inputs

  • refreshOptions — Bypass cached dropdown values and fetch fresh options
  • AgentStatus__path__domain (required) —
  • AgentStatus__path__callqueue-agent-id (required) — Identifier of the call‑queue agent
  • AgentStatus__path__status (required) — Custom status code (cust1‑cust8) to use for offline

Output shape

a success response with no body; errors are indicated by HTTP status codes

The operation returns no payload on success; failure returns an error object

Examples

Example 1: Mark an agent offline using the default domain

Domain: example.com, Callqueue Agent ID: 12345, Status: cust1

Example 2: Refresh dropdown before selecting status

RefreshOptions: true, Domain: example.com, Agent ID: 12345, Status: cust5

Example 3: Set offline with a custom domain

Domain: other.com, Agent ID: 9876, Status: cust2

Links

Discussion