WhatsApp Calling

Enable calling on a number — estimate

Price the request without executing it. Same body as POST /v1/messaging/phone-numbers/{id}/whatsapp/calling.

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

Request

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

Path parameters

idstring required

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

Request body

accountIdstring required
forwardTostring required

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

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.

sipAuthPasswordstring

Stored encrypted, never returned by any endpoint.

sipAuthUsernamestring
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.

Response

Estimate

operationstring
estimated_creditsnumber
credits_to_reservenumber
estimated_usageobject
notestring nullable
sufficientboolean

Changes

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