Voice Calls API

Call control endpoints. Commands are executed on behalf of a Unexus agent and are forwarded to the telephony platform.

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

Start an outbound call

POST /api/v1/voice/calls/dial

{
  "agentUri": "agent1@customer.unexus.nl",
  "destination": "+31201234567",
  "cli": "+31207654321",
  "correlationId": "crm-42"
}

Field	Required	Description
`agentUri`	yes	Agent that initiates the call. Omitting it returns `401 Unauthorized`.
`destination`	yes	Number or URI to dial.
`cli`	no	Outbound presentation number.
`correlationId`	no	Your identifier for command/event tracing.

Answer a call

POST /api/v1/voice/calls/{callId}/answer

{ "agentUri": "agent1@customer.unexus.nl" }

Hang up a call

POST /api/v1/voice/calls/{callId}/hangup

{ "agentUri": "agent1@customer.unexus.nl" }

Hold the active call

POST /api/v1/voice/calls/{callId}/hold

{ "agentUri": "agent1@customer.unexus.nl" }

Resume a held call

POST /api/v1/voice/calls/{callId}/resume

{ "agentUri": "agent1@customer.unexus.nl" }

Transfer a call

POST /api/v1/voice/calls/{callId}/transfer

{
  "agentUri": "agent1@customer.unexus.nl",
  "transferTarget": "agent2@customer.unexus.nl",
  "blind": false,
  "correlationId": "crm-42"
}

Field	Required	Description
`agentUri`	yes	Agent that owns the call. Omitting it returns `401 Unauthorized`.
`transferTarget`	yes	Agent URI, extension, or external number.
`blind`	no	`true` = blind (unattended) transfer; `false` (default) = attended.
`correlationId`	no	Your identifier for tracing.

Responses

Commands are asynchronous at the telephony level: a 2xx response means the command was accepted, not that the call state has already changed. Track actual call progress via the call.status webhook event.

Common error responses are described in Errors.