Skip to main content
GET
List WhatsApp senders

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

status
enum<string>

Filters senders by registration status. Possible values:

  • banned — The provider banned the sender.
  • connected — The sender can send messages within its messaging limit.
  • deleted — The sender was deleted.
  • disconnected — The sender is disconnected from the provider.
  • flagged — The sender's quality rating dropped to low. The status returns to connected if the rating returns to medium or high within seven days.
  • migrated — The sender was migrated.
  • pending — Registration with the provider is in progress.
  • rate_limited — The provider is rate limiting the sender.
  • restricted — The sender reached its messaging limit. It can't start new conversations until the 24-hour window resets, but it can still reply to customers who messaged it.
  • unknown — The provider hasn't reported a status.
  • unverified — The sender isn't verified.
Available options:
banned,
connected,
deleted,
disconnected,
flagged,
migrated,
pending,
rate_limited,
restricted,
unknown,
unverified
waba_id
string

Filters senders by the ID of the WhatsApp Business Account they belong to, as returned in waba.id.

page
integer<int32>
default:1

Page number to retrieve. Page numbering starts at 1. Defaults to 1.

per_page
integer<int32>
default:25

Number of records to return per page. Defaults to 25. Values above 100 are treated as 100.

Response

A paginated list of WhatsApp senders.

Returned by whatsapp_senders_list.

senders
WhatsAppSender · object[]
required

Senders that match the request.

pagination
Pagination · object
required