List messages

GET

{phone_number_id}

messages

List messages

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

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

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages', 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}/messages",
  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}/messages"

	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}/messages")

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": "wamid.HBgNMTU1NTE0OTU5Nzg1FQIAERgSMDhGRjdBMDEyOTcxQzFFQkFBAA==",
      "timestamp": "1705328096",
      "type": "text",
      "from": "15551234567",
      "text": {
        "body": "Hello! I need help with my order"
      },
      "kapso": {
        "direction": "inbound",
        "status": "delivered",
        "processing_status": "completed",
        "phone_number": "+15551234567",
        "has_media": false,
        "whatsapp_conversation_id": "123e4567-e89b-12d3-a456-426614174000",
        "contact_name": "John Doe",
        "content": "Hello! I need help with my order"
      }
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNVQxMjozNDo1Ni4xMjM0NTZaIiwiMTIzNDUiXSwiY29sdW1ucyI6WyJjcmVhdGVkX2F0IiwiaWQiXX0="
    }
  }
}

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

conversation_id

string

Filter by conversation ID

direction

enum<string>

Filter by message direction

Available options:

inbound,

outbound

status

enum<string>

Filter by message status

Available options:

pending,

sent,

delivered,

read,

failed

since

string<date-time>

Filter messages created on or after this time (ISO 8601)

until

string<date-time>

Filter messages created on or before this time (ISO 8601)

limit

integer

default:20

Maximum number of results per page (default 20, max 100)

Required range: 1 <= x <= 100

before

string

Cursor for previous page (Base64 encoded)

after

string

Cursor for next page (Base64 encoded)

fields

string

Filter response fields. Use kapso() to include Kapso-specific extensions.

Example: fields=kapso(direction,status,processing_status)

Response

Successfully retrieved messages

data

object[]

required

Show child attributes

paging

object

Show child attributes

Send a messageSend a WhatsApp message to a recipient. Use `to` for phone numbers. Use `recipient` for a BSUID or parent BSUID. If both are present, the phone number in `to` takes precedence. Supports all WhatsApp message types: - **text**: Plain text messages with optional URL preview - **image**: Images with optional caption - **video**: Videos with optional caption - **audio**: Audio files - **document**: Documents with optional caption and filename - **sticker**: Stickers - **location**: Location sharing - **contacts**: Contact cards - **interactive**: Interactive messages (buttons, lists, flows) - **template**: Message templates - **reaction**: Emoji reactions to messages

List messages

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

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

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages', 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}/messages",
  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}/messages"

	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}/messages")

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": "wamid.HBgNMTU1NTE0OTU5Nzg1FQIAERgSMDhGRjdBMDEyOTcxQzFFQkFBAA==",
      "timestamp": "1705328096",
      "type": "text",
      "from": "15551234567",
      "text": {
        "body": "Hello! I need help with my order"
      },
      "kapso": {
        "direction": "inbound",
        "status": "delivered",
        "processing_status": "completed",
        "phone_number": "+15551234567",
        "has_media": false,
        "whatsapp_conversation_id": "123e4567-e89b-12d3-a456-426614174000",
        "contact_name": "John Doe",
        "content": "Hello! I need help with my order"
      }
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNVQxMjozNDo1Ni4xMjM0NTZaIiwiMTIzNDUiXSwiY29sdW1ucyI6WyJjcmVhdGVkX2F0IiwiaWQiXX0="
    }
  }
}

Overview

WhatsApp API

Platform API

Workflows API

Authorizations

Path Parameters

Query Parameters

Response