WhatsApp

Check call permission for a user

Whether you may place a business-initiated call to user from number_id. Temporary permissions last 7 days; permanent ones until the user revokes them. Served from PyAI's cache when live, otherwise refreshed from Meta (refresh=true forces it). Requires the telephony:manage scope.

get/v1/whatsapp/call-permissions

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/whatsapp/call-permissions
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

number_idstring required
userstring required

The user's WhatsApp number (E.164).

refreshboolean

Response

Permission state

objectstring
number_idstring
userstring
status'temporary' | 'permanent' | 'rejected' | 'none'
sourcestring nullable

user_action | automatic | api

expires_atinteger nullable

Unix ms (temporary only).

updated_atinteger

Example response

{
  "object": "whatsapp.call_permission",
  "user": "+919876543210"
}

Changes

No recorded changes to this operation across all 1 revision of this API.