Place a test call
Ring a number and have the agent speak one phrase, then hang up. A probe rather than a conversation: it answers “is my trunk configured and does this agent sound right” in a few seconds, without anyone having to hold a conversation with it. For a real conversation use POST /v1/calls.
It rings a real phone over your real carrier and it spends real credit — the meter runs on a test call exactly as on any other, so it needs calls:write and an Idempotency-Key.
Human transfer is deliberately not offered during a test call, so this cannot be used to check that a transfer destination answers.
Authorizations
Your Wixzel Phone API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Path Parameters
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
Body
The number to ring. A real call to a real phone.
^\+[1-9]\d{6,14}$"+14155550100"
Defaults to the agent's own outbound number.
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
What to say. Defaults to the agent's opening message, which is usually what you want to hear.
1 - 300"This is a test call from Wixzel Phone. Goodbye."
Response
The test call, queued
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
call Stable id for this call across logs, usage and webhooks.
queued, ringing, in-progress, completed, failed, busy, no-answer, canceled inbound, outbound ^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
Micro-USD. 1_000_000 = $1.00.
194000
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.
21
What to actually do about the failure, in plain language. Null if the call connected.
"The provider rejected the call outright (403/407). In order of likelihood: your carrier account is suspended, closed, or out of balance; …"
ISO 8601, always UTC.
"2026-09-01T12:00:00.000Z"
ISO 8601, always UTC.
"2026-09-01T12:00:00.000Z"

