Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
WhatsApp Calling

Get calling config for a number

The WhatsApp Business Calling configuration of this number, keyed the same way as the POST/PATCH/DELETE below (full read-write on one sub-resource). Encrypted secrets are never returned; only a boolean saying whether a SIP password is stored. The account-scoped read (GET /v1/whatsapp/calling?accountId=) remains for callers that only know the social account id, and additionally carries account-level extras (billing eligibility, current-period spend).

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

Path parameters

idstring required

Phone number record ID (from GET /v1/phone-numbers).

Response

Calling config

phoneNumberstring
callingEnabledboolean
callDeepLinkstring nullable

Public calling deep link (https://wa.me/call/<number>). Null while calling is disabled.

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
outboundDisabledboolean

True when the number's country blocks business-initiated (outbound) WhatsApp calling; inbound still works.

callerIdMode'business' | 'platform'

Caller ID the forward-leg callee sees on tel: forwards. business = this WhatsApp number; platform = a Zernio number (used when the number was brought by the customer and its caller ID is not verified for PSTN origination).

callerIdVerifiedboolean

True once the number completed caller-ID verification, making tel: forwards display the business number itself.

maxCallDurationSecondsinteger nullable

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

forwardCallerId'business' | 'caller'