Skip to main content
POST
Place a call

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Headers

Idempotency-Key
string
required

A unique value per call attempt, e.g. a UUID.

Required string length: 1 - 255

Body

application/json
to
string
required
Pattern: ^\+[1-9]\d{6,14}$
Example:

"+14155550100"

agent_id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

from_number_id
string

Defaults to the agent's outbound number.

Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

lead_id
string

Existing lead to attribute the call to. One is created if omitted.

Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

lead_name
string
Maximum string length: 200
metadata
object

Echoed back on the call and in webhooks. Not sent to the model.

Response

The call, queued for dialling

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
call
session_id
string
required

Stable id for this call across logs, usage and webhooks.

status
enum<string>
required
Available options:
queued,
ringing,
in-progress,
completed,
failed,
busy,
no-answer,
canceled
direction
enum<string>
required
Available options:
inbound,
outbound
agent_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

lead_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

campaign_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

from
string | null
required
to
string | null
required
duration_seconds
integer | null
required
engine
string | null
required
recording_url
string | null
required
summary
string | null
required
cost_micros
integer | null
required

Micro-USD. 1_000_000 = $1.00.

Example:

194000

started_at
string<date-time> | null
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

ended_at
string<date-time> | null
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"