Skip to main content
flag
Mon - Fri   10:00 – 18:00

Message Status

API Documentation / WhatsApp / Message Status

Base URL for your account: https://cpaas.studio

GET /api/whatsapp/v1/messages/{ref}

One message by the ref the send returned: our status, its error (mapped status + provider_code), billing, and every timestamp.

Parameters

Param Type Required Notes
ref string (path) yes e.g. 1aB3-202610.

Request example

curl -X GET "https://cpaas.studio/api/whatsapp/v1/messages/1aB3-202610" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (data)

{
    "message": {
        "ref": "1aB3-202610",
        "wa_message_id": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgS",
        "channel": "WCH54DZ7M7M5V",
        "to": "+919876543210",
        "from": null,
        "direction": "out",
        "source": "api",
        "campaign": null,
        "type": "template",
        "category": "utility",
        "status": "delivered",
        "provider_status": "accepted",
        "error": null,
        "billing": {
            "status": "billed",
            "amount": 0.115
        },
        "timestamps": {
            "created": "2026-10-10T09:15:00+00:00",
            "submitted": "2026-10-10T09:15:01+00:00",
            "sent": "2026-10-10T09:15:02+00:00",
            "delivered": "2026-10-10T09:15:04+00:00",
            "read": null,
            "failed": null
        }
    }
}

Notes

  • status: queued, submitted, sent, delivered, read, failed (also rejected / capped), or skipped_* for campaign recipients that were excluded, cancelled for a cancelled campaign.
  • provider_status held_for_quality_assessment: Meta accepted it but has not sent it yet — it is not counted as sent until a "sent" status arrives.
  • error (failed only): code / label / message are our mapped status (see "Message statuses and errors"); provider_code is Meta's raw code. The raw provider text is never returned.
  • Messages older than your account's visible retention, and other accounts' refs, are 404.

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.