Voice Agents API

Query and control agent state.

Base path: /api/v1/voice/agents All endpoints require authentication.

The {agentUri} path parameter is the Unexus user URI of the agent, e.g. agent1@customer.unexus.nl. URL-encode it when it contains special characters.

Get agent state

GET /api/v1/voice/agents/{agentUri}/state

Returns the agent’s current presence/status information, including status code, device status, and whether the agent is logged on.

Get agent call state

GET /api/v1/voice/agents/{agentUri}/call-state

Returns the current call state of the agent’s device (active calls, hold state, remote party).

Set agent presence

POST /api/v1/voice/agents/{agentUri}/presence

{
  "statusCode": "2",
  "until": "2026-07-21T17:00:00Z",
  "message": "Working from home",
  "location": "Home office"
}

Field	Required	Description
`statusCode`	yes	Numeric user status code to set (see table below).
`until`	no	Timestamp at which the status automatically expires.
`message`	no	Free-text status message.
`location`	no	Location to set together with the status.

User status codes

The most commonly used values:

Code	Status
0	Unknown
1	Offline
2	Available
10	Busy
14	Be right back
34	Away / Off work
50	On the phone
66	Lunch
82	Meeting
98	Out of office
114	Do not disturb
130	Conference
144	Working
146	After call work
160	Ill
161	Gone for the day
162	Business trip
176	Holiday
177	Other