Skip to main content
GET
/
{phone_number_id}
/
call_permissions
Get call permission state
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{phone_number_id}/call_permissions \
  --header 'X-API-Key: <api-key>'
{
  "messaging_product": "whatsapp",
  "permission": {
    "status": "temporary",
    "expiration_time": 1745343479
  },
  "actions": [
    {
      "action_name": "send_call_permission_request",
      "can_perform_action": true,
      "limits": [
        {
          "time_period": "PT24H",
          "max_allowed": 1,
          "current_usage": 0
        },
        {
          "time_period": "P7D",
          "max_allowed": 2,
          "current_usage": 1
        }
      ]
    },
    {
      "action_name": "start_call",
      "can_perform_action": false,
      "limits": [
        {
          "time_period": "PT24H",
          "max_allowed": 5,
          "current_usage": 5,
          "limit_expiration_time": 1745622600
        }
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Query Parameters

​
user_wa_id
string
required

WhatsApp ID of the user (phone number)

Response

Permissions retrieved successfully

​
messaging_product
enum<string>
required
Available options:
whatsapp
Example:

"whatsapp"

​
permission
object
required
​
actions
object[]
required

Available actions with their limits