List WhatsApp conversations

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

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

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

	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_conversations")

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": "conversation-202mno",
      "phone_number": "+1234567890",
      "status": "active",
      "last_active_at": "2023-11-07T05:31:56Z",
      "contact_name": "John Doe",
      "whatsapp_config_id": "config-123abc"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

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

GET

whatsapp_conversations

List WhatsApp conversations

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

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

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

	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_conversations")

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": "conversation-202mno",
      "phone_number": "+1234567890",
      "status": "active",
      "last_active_at": "2023-11-07T05:31:56Z",
      "contact_name": "John Doe",
      "whatsapp_config_id": "config-123abc"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

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

q[status_eq]

enum<string>

Filter by exact status match

Available options:

active,

ended

q[last_active_at_gteq]

string<date-time>

Filter by last_active_at greater than or equal to (ISO 8601 format)

q[last_active_at_lteq]

string<date-time>

Filter by last_active_at less than or equal to (ISO 8601 format)

q[whatsapp_config_id_eq]

string<uuid>

Filter by exact whatsapp_config_id match

q[whatsapp_config_customer_id_eq]

string<uuid>

Filter by customer_id through whatsapp_config relationship

q[phone_number_eq]

string

Filter by exact phone number match (automatically normalized)

Response

A list of WhatsApp conversations

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 conversations

Authorizations

Query Parameters

Response