Console

Get campaign

.md

GET

https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/campaigns/{id}

Token ability: campaigns.read · Authentication

A campaign with its results (stats). Definitions: audience - recipients fixed when the run started; queued / skipped (with skip_reasons) / cancelled - what PaalChat did with each; sent, delivered, read, failed - the messages' statuses now (delivered includes read); replied - recipients who wrote back on the same conversation within 72 hours of the send; rates are of sent messages, failure of sent plus failed; estimated_meta_cost - from Meta's pricing reports, an estimate.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

id integer required

Responses

200

The campaign and its results.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.

Language

Credentials

Authorization Bearer $PAALCHAT_TOKEN

Request

cURL

curl --request GET \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json'

const response = await fetch('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.PAALCHAT_TOKEN}`,
    Accept: 'application/json',
  },
});

const data = await response.json();
console.log(response.status, data);

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('PAALCHAT_TOKEN'))
    ->acceptJson()
    ->get('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2');

$data = $response->json();

import os
import requests

response = requests.get(
    "https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2",
    headers={"Authorization": f"Bearer {os.environ['PAALCHAT_TOKEN']}", "Accept": "application/json"},
)

print(response.status_code, response.json())

require 'net/http'
require 'json'

uri = URI('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = "Bearer #{ENV['PAALCHAT_TOKEN']}"
request['Accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, JSON.parse(response.body)

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns/2", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAALCHAT_TOKEN"))
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

Try it with a test key

Only sk_test_ keys: requests reach your sandbox businesses, never real ones. The key is not saved.

Test key

external_id

id

Response

Response

{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}

{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}

{"error": {"code": "not_found", "message": "Business not found."}}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}