WhatsApp Developer API & OpenAPI

This developer guide walks through integrating WhatsApp Business Platform APIs into your custom backend systems.

1. Authentication & API Key Lifecycle

To make authenticated API calls, generate an organization static API Key.

Navigate to Console > WhatsApp > API Keys (/console/whatsapp/api-keys).
Click Generate API key and copy the one-time secret.

Pass the key in your HTTP requests:

HTTP

Authorization: Bearer pfn_wa_sec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

HTTP

x-api-key: pfn_wa_sec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

2. Interactive OpenAPI Specification

Visit /api/openapi to access the interactive OpenAPI documentation with schema definitions, required parameters, and response models.

Key WhatsApp Endpoints:

POST /api/whatsapp/messages — Send template, text, or interactive messages.
GET /api/whatsapp/devices — List connected WhatsApp sender numbers.
GET /api/whatsapp/templates — List registered templates and dynamic parameters.

3. Switching Code Examples

The API Reference provides ready-to-use code snippets in multiple languages:

4. Code Examples

cURL

BASH

curl -X POST "https://pfnapp.id/api/whatsapp/messages" \
  -H "Authorization: Bearer pfn_wa_sec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+6281234567890",
    "type": "template",
    "template": {
      "name": "order_status_update",
      "language": {
        "code": "id"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            { "type": "text", "text": "Budi" },
            { "type": "text", "text": "INV-2026-001" }
          ]
        }
      ]
    }
  }'

TypeScript / Node.js

TYPESCRIPT

const response = await fetch("https://pfnapp.id/api/whatsapp/messages", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PFN_WHATSAPP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "+6281234567890",
    type: "template",
    template: {
      name: "order_status_update",
      language: { code: "id" },
      components: [
        {
          type: "body",
          parameters: [
            { type: "text", text: "Budi" },
            { type: "text", text: "INV-2026-001" },
          ],
        },
      ],
    },
  }),
})
 
const data = await response.json()
console.log("API Response:", data)

Python

PYTHON

import os
import requests
 
url = "https://pfnapp.id/api/whatsapp/messages"
headers = {
    "Authorization": f"Bearer {os.getenv('PFN_WHATSAPP_API_KEY')}",
    "Content-Type": "application/json",
}
payload = {
    "to": "+6281234567890",
    "type": "template",
    "template": {
        "name": "order_status_update",
        "language": {"code": "id"},
        "components": [
            {
                "type": "body",
                "parameters": [
                    {"type": "text", "text": "Budi"},
                    {"type": "text", "text": "INV-2026-001"},
                ],
            }
        ],
    },
}
 
res = requests.post(url, json=payload, headers=headers)
print(res.status_code, res.json())