Skip to main content
GET
List messages of a broadcast

Authorizations

api-key
string
header
required

Path Parameters

broadcastId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

cursor
string

Opaque cursor returned by a previous call, used to fetch the next page

status
string

Filter by broadcast message status.

Possible values:

  • pending — Message queued, not yet sent to WhatsApp.
  • sent — Message sent to WhatsApp, awaiting delivery confirmation.
  • delivered — WhatsApp confirmed the message was delivered to the recipient.
  • read — WhatsApp confirmed the recipient read the message.
  • failed — The send attempt or WhatsApp delivery failed.
  • skipped — The recipient was skipped (e.g., marketing opt-out).

Response

A paginated list of broadcast messages

data
object[]
required
cursors
object