WhatsApp · WhatsApp Calling

Check call permission

Checks a call permission.

GEThttps://api.pozy.ai/v1/whatsapp/call-permissions

getWhatsAppCallPermissions

Request

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

Query parameters

Name	Type	Notes
`accountId`required	string
`to`required	string

Example

curl -X GET "https://api.pozy.ai/v1/whatsapp/call-permissions?accountId=696e0b682d0a31188e7a2ba9&to=%2B14155550123" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/whatsapp/call-permissions?accountId=696e0b682d0a31188e7a2ba9&to=%2B14155550123", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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.get(
    "https://api.pozy.ai/v1/whatsapp/call-permissions",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "to": "+14155550123",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

permissionobject
- statusstring
  One of temporary, no_permission, permanent.
- expiration_timeinteger
actionsarray of object
- action_namestring
  One of send_call_permission_request, start_call.
- can_perform_actionboolean

200 response

{
  "permission": {
    "status": "temporary",
    "expiration_time": 1
  },
  "actions": [
    {
      "action_name": "send_call_permission_request",
      "can_perform_action": true
    }
  ]
}

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 scoped to other profiles or has this resource group disabled.
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 POSTEnable calling on a number PATCHUpdate calling config DELDisable calling on a number 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