Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
WhatsApp Calling

Enable calling on a number

Deprecated alias of /v1/phone-numbers/{id}/whatsapp/calling; same contract. New integrations should use that path.

Enable WhatsApp Business Calling on a connected number. Configures Meta calling.status=ENABLED with our Telnyx SIP endpoint, fetches and stores the Meta-issued SIP password (encrypted), and snapshots the customer's forward-to destination.

post/v1/whatsapp/phone-numbers/{id}/calling

Path parameters

idstring required

WhatsAppPhoneNumber Mongo ID

Request body

accountIdstring required
forwardTostring required

tel:+E164 / sip:... / wss://... destination

sipAuthUsernamestring
sipAuthPasswordstring

Stored encrypted, never returned by any endpoint.

recordingEnabledboolean
callIconCountriesstring[]
maxCallDurationSecondsinteger

Hard cap (seconds) on a forwarded call; the carrier hangs up both legs when it fires. Safety valve against dead-air billing when a destination hangs up but the signal is lost.

forwardCallerId'business' | 'caller'

Caller ID presented to the forward destination. caller = the WhatsApp user's number (sip: destinations only; ignored on tel: forwards). Fixes AI-agent trunks that reject seeing the business number call itself.

Response

Calling enabled

successboolean
callingEnabledboolean
sipHostnamestring
forwardTostring
callerIdMode'business' | 'platform'

Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (customer-brought number without verified caller ID).