Voice

Place an outbound phone call

Dials to FROM one of your voice-enabled numbers and, on answer, bridges the callee to the number's stored forward destination, or to the per-call forwardTo override. Destinations can be your own AI voice agent (Vapi/Retell), a phone, or a SIP endpoint. An optional greeting is spoken to the callee before the bridge.

The 200 response means the call is dialing; the lifecycle continues asynchronously (track it via GET /v1/voice/calls/{id} or the call.* webhooks). Outbound calls are capped per rolling hour (429 when hit).

Idempotency: send an Idempotency-Key header to make retries safe; same key + same body replays the original response instead of dialing (and billing) a second call.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/voice/calls

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/voice/calls
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

tostring required

Destination to dial, E.164 with leading +.

amdboolean

Answering-machine detection; defers the bridge until human vs machine is known.

greetingstring

Spoken to the callee when they answer, before the bridge.

forwardTostring

Per-call agent override (tel:+E164, sip:..., or wss://...); defaults to the number's stored forward destination.

fromNumberstring

Which of your voice-enabled numbers to dial from. Optional when you have exactly one.

recordOverrideboolean

Per-call recording toggle; defaults to the number's setting.

ringTimeoutSecondsinteger

Seconds to let the callee's phone ring before the call ends as no_answer. The destination carrier can end it sooner.

transcribeOverrideboolean

Per-call transcription toggle; defaults to the number's setting.

voicemailDropMessagestring

Spoken to a detected machine, then hang up (implies amd). For outbound voicemail drops.

transcriptionLanguage'auto' | 'en' | 'es'

'auto' derives from the callee's country; 'en'/'es' force it.

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.