---
title: "Get calling config for an account"
method: GET
path: "/v1/messaging/whatsapp/calling"
tags: ["WhatsApp Calling"]
---

# Get calling config for an account

`GET /v1/messaging/whatsapp/calling`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/whatsapp/calling`
- Auth: HTTP bearer

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.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Query parameters

- `accountId` string, required: WhatsApp account ID

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: 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`
    - `forwardTo` string, nullable: tel:+E164 / sip:... / wss://... destination
    - `phoneNumber` string
    - `callDeepLink` string, 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.
    - `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).
    - `callingEnabled` boolean
    - `forwardCallerId` 'business' | 'caller'
    - `sipAuthUsername` string, nullable
    - `callerIdVerified` boolean: True once the number completed caller-ID verification.
    - `phoneNumberDocId` string: Phone number record ID (use on /v1/phone-numbers/{id}/whatsapp/calling)
    - `recordingEnabled` boolean
    - `callIconCountries` string[], nullable
    - `maxCallDurationSeconds` integer, nullable: Hard cap (seconds) on forwarded calls; null = no cap.
    - `sipAuthPasswordConfigured` boolean: True when a SIP digest password is stored. The plaintext is never returned.
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)