ZAzavudev

List broadcast contacts

Changed on

List contacts in a broadcast with optional status filter.

get/v1/broadcasts/{broadcastId}/contacts

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts
  • Auth
    HTTP bearer

Path parameters

broadcastIdstring required

Query parameters

status'pending' | 'queued' | 'sending' | 'sent' | 'delivered' | 'failed' | 'skipped'

Status of a contact within a broadcast.

  • pending, queued, sending: not handed to the provider yet.
  • sent: accepted by the provider; delivery is not confirmed yet. Channels that never report delivery leave the recipient here.
  • delivered: the channel confirmed delivery to the device. A WhatsApp read receipt also counts as delivered.
  • failed: not delivered. A recipient can move from sent or delivered to failed when the provider reports a failure late.
  • skipped: not sent, because the recipient opted out of the channel or the broadcast was cancelled before reaching it.
limitinteger
cursorstring

Response

List of broadcast contacts.

nextCursorstring nullable

Changes

  • fe72e5565564Revision changes
    • info

      added the optional property // to the response with the status

  • 3e45958691daRevision changes
    • info

      added the optional property // to the response with the status