Calls

Get call permission state

Get the call permission state for a business phone number with a specific WhatsApp user.

Proxy endpoint: Proxies directly to Meta Graph API.

Returns the current permission status and available actions with their limits. Permission can be:

no_permission: No calling permission granted
temporary: Temporary permission with expiration time
permanent: Permission without a temporary expiration

Identify the user with user_wa_id (phone number) or recipient (business-scoped user ID). Require an actions[] item with action_name: start_call and can_perform_action: true before dialing; permission status alone is insufficient.

Actions include:

send_call_permission_request: Send permission request message
start_call: Initiate a call

Each action has time-based limits (e.g., max 2 permission requests per 24 hours).

GET

{phone_number_id}

call_permissions

Get call permission state

curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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 Integrations > API keys.

Path Parameters

phone_number_id

string

required

WhatsApp Business Phone Number ID

Query Parameters

user_wa_id

string

WhatsApp ID of the user (phone number). Required unless recipient is provided.

recipient

string

Business-scoped user ID (BSUID) or parent BSUID. Use instead of user_wa_id.

Response

Permissions retrieved successfully

messaging_product

enum<string>

required

Available options:

whatsapp

Example:

"whatsapp"

permission

object

required

Show child attributes

actions

object[]

required

Available actions with their limits

Show child attributes

Get call permission state

curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/call_permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
        }
      ]
    }
  ]
}

Overview

WhatsApp API

Platform API

Workflows API

Kapso Agent API

Get call permission state

Authorizations

Path Parameters

Query Parameters

Response