List WhatsApp calls

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_calls \
  --header 'X-API-Key: <api-key>'

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

fetch('https://app.kapso.ai/api/v1/whatsapp_calls', 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://app.kapso.ai/api/v1/whatsapp_calls",
  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://app.kapso.ai/api/v1/whatsapp_calls"

	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://app.kapso.ai/api/v1/whatsapp_calls")

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

{
  "data": [
    {
      "id": "call-123abc",
      "project_id": "project-456def",
      "whatsapp_config_id": "config-789ghi",
      "config_display_name": "Customer Support Line",
      "config_display_phone_number": "+1234567890",
      "voice_agent_id": "agent-101jkl",
      "voice_agent_name": "Support Agent",
      "call_id": "wa-call-xyz123",
      "direction": "inbound",
      "status": "completed",
      "duration_seconds": 180,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "session_started_at": "2023-11-07T05:31:56Z",
      "user_wa_id": "1234567890",
      "whatsapp_contact_id": "contact-202mno",
      "whatsapp_conversation_id": "conversation-303pqr",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

GET

whatsapp_calls

List WhatsApp calls

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_calls \
  --header 'X-API-Key: <api-key>'

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

fetch('https://app.kapso.ai/api/v1/whatsapp_calls', 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://app.kapso.ai/api/v1/whatsapp_calls",
  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://app.kapso.ai/api/v1/whatsapp_calls"

	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://app.kapso.ai/api/v1/whatsapp_calls")

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

{
  "data": [
    {
      "id": "call-123abc",
      "project_id": "project-456def",
      "whatsapp_config_id": "config-789ghi",
      "config_display_name": "Customer Support Line",
      "config_display_phone_number": "+1234567890",
      "voice_agent_id": "agent-101jkl",
      "voice_agent_name": "Support Agent",
      "call_id": "wa-call-xyz123",
      "direction": "inbound",
      "status": "completed",
      "duration_seconds": 180,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "session_started_at": "2023-11-07T05:31:56Z",
      "user_wa_id": "1234567890",
      "whatsapp_contact_id": "contact-202mno",
      "whatsapp_conversation_id": "conversation-303pqr",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key

string

header

required

API key required for all endpoints

Query Parameters

page

integer

default:1

Required range: x >= 1

per_page

integer

default:20

Required range: 1 <= x <= 100

status

string

Filter by call status

direction

enum<string>

Filter by call direction

Available options:

inbound,

outbound

voice_agent_id

string<uuid>

Filter by voice agent ID

whatsapp_config_id

string<uuid>

Filter by WhatsApp configuration ID

period

enum<string>

Filter by time period

Available options:

today,

week,

month,

custom

start_date

string<date-time>

Start date for custom period (ISO 8601 format)

end_date

string<date-time>

End date for custom period (ISO 8601 format)

Response

A list of WhatsApp calls

data

object[]

Show child attributes

Guides

WhatsApp Conversations

WhatsApp Messages

Conversation Assignments

WhatsApp Templates

WhatsApp Contacts

WhatsApp Contact Notes

WhatsApp Configs

WhatsApp Calls

WhatsApp Contact Call Permissions

List WhatsApp calls

Authorizations

Query Parameters

Response