Skip to main content
POST
Place a test call

Authorizations

Authorization
string
header
required

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

Path Parameters

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

"6a96a3ead6e886d42462dd3e"

Body

application/json
to
string
required

The number to ring. A real call to a real phone.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+14155550100"

from_number_id
string

Defaults to the agent's own outbound number.

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

"6a96a3ead6e886d42462dd3e"

phrase
string

What to say. Defaults to the agent's opening message, which is usually what you want to hear.

Required string length: 1 - 300
Example:

"This is a test call from Wixzel Phone. Goodbye."

Response

The test call, queued

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

failure_code
integer | null
required

Q.850 hangup cause from the carrier, or null if the call connected. Branch on this rather than on failure_reason, which is prose and may be reworded. 17 busy, 19 no answer, 21 rejected by the carrier, 34 congestion, 102 timeout.

Example:

21

failure_reason
string | null
required

What to actually do about the failure, in plain language. Null if the call connected.

Example:

"The provider rejected the call outright (403/407). In order of likelihood: your carrier account is suspended, closed, or out of balance; …"

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"