Skip to main content

SetAgentStatus sets an agent's current status.

POST 
/api/v1/voice/agents/:agentId/status

Changes the agent's status and records the transition in history. The queue_behavior of the new status affects call routing.

Parameters​

  • agent_id: Required, agent to update
  • status_id: Required, status configuration to apply
  • call_id: Optional, associated call (for on-call statuses)

Side Effects​

  • Closes previous status history record
  • Updates queue membership availability
  • Publishes status change event

Errors​

  • NOT_FOUND: Agent or status not found
  • PERMISSION_DENIED: Caller lacks permission to update agent

Request​

Responses​

A successful response.