WhatsApp Calling

Update calling config

Update fields on an already-enabled number. Only fields present in the body are written; undefined leaves the stored value alone, explicit null clears a nullable field. No Meta side effect, this only changes local routing state consumed by the Telnyx webhook handler.

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

patch/v1/messaging/phone-numbers/{id}/whatsapp/calling

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/phone-numbers/{id}/whatsapp/calling
  • Auth: HTTP bearer

Path parameters

idstring required

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

accountIdstring required
forwardTostring
forwardCallerId'business' | 'caller'

caller = present the WhatsApp user's number to the forward destination (sip: only).

sipAuthPasswordstring nullable
sipAuthUsernamestring nullable
recordingEnabledboolean
callIconCountriesstring[] nullable
maxCallDurationSecondsinteger nullable

Hard cap (seconds) on forwarded calls; null clears the cap.

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
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

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