v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

WhatsApp Calling

Get calling config for an account

Returns the local calling configuration snapshot for the connected WhatsApp account: whether calling is enabled, the forward-to destination URI, recording opt-in state, the phone number record id (use as {id} on the read-write calling sub-resource at /v1/phone-numbers/{id}/whatsapp/calling) and whether SIP digest credentials are stored (the encrypted password itself is never returned). Also carries account-level extras (billing eligibility, current-period spend) that the number-keyed GET does not.

get/v1/whatsapp/calling

Query parameters

accountIdstring required

WhatsApp social account ID

Response

Calling config

phoneNumberDocIdstring

Phone number record ID (use on /v1/phone-numbers/{id}/whatsapp/calling)

phoneNumberstring

callingEnabledboolean

callDeepLinkstring nullable

Public calling deep link (https://wa.me/call/<number>). Tapping it on a phone starts a WhatsApp voice call to this number. Embed it on websites, emails, or QR codes. Null while calling is disabled; not supported by WhatsApp desktop clients.

forwardTostring nullable

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

recordingEnabledboolean

sipAuthUsernamestring nullable

sipAuthPasswordConfiguredboolean

True when a SIP digest password is stored. The plaintext is never returned.

callIconCountriesstring[] nullable

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; verify via /v1/phone-numbers/{id}/whatsapp/caller-id-verification).

callerIdVerifiedboolean

True once the number completed caller-ID verification.

maxCallDurationSecondsinteger nullable

Hard cap (seconds) on forwarded calls; null = no cap.

forwardCallerId'business' | 'caller'