WhatsApp · WhatsApp Calling

Enable calling on a number

Enables a calling on a number.

POSThttps://api.pozy.ai/v1/whatsapp/phone-numbers/{id}/calling

DeprecatedenableWhatsAppCallingLegacy

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`id`required	string

Request body

application/json, required

accountIdstringrequired
forwardTostringrequired
sipAuthUsernamestring
sipAuthPasswordstring
recordingEnabledboolean
Default false.
callIconCountriesarray of string
Each item: 2 to 2 characters.
maxCallDurationSecondsinteger
30 to 14400.
forwardCallerIdstring
One of business, caller. Default business.

Example

curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/6bfebd43ddc270f6d2c56fc5/calling" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "forwardTo": "string"
}'

const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/6bfebd43ddc270f6d2c56fc5/calling", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9",
    forwardTo: "string"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.post(
    "https://api.pozy.ai/v1/whatsapp/phone-numbers/6bfebd43ddc270f6d2c56fc5/calling",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "forwardTo": "string",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
callingEnabledboolean
sipHostnamestring
forwardTostring
callerIdModestring
One of business, platform.

200 response

{
  "success": true,
  "callingEnabled": true,
  "sipHostname": "Acme",
  "forwardTo": "string",
  "callerIdMode": "business"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in WhatsApp Calling

GETGet calling config for an account PATCHUpdate calling config DELDisable calling on a number GETCheck call permission GETList call history for an account POSTInitiate outbound call GETGet a single call GETGet a call recording GETEstimate per-minute cost GETGet calling config for a number POSTEnable calling on a number PATCHUpdate calling config DELDisable calling on a number POSTStart caller-ID verification for a customer-brought number POSTConfirm the caller-ID verification code