WAwavix
WhatsApp

List WhatsApp senders

Changed on

Returns a paginated list of the WhatsApp senders in your account's WhatsApp Business Accounts, each with the WhatsApp Business Account it belongs to.

Every send needs a registered sender's number in from, and this is where that number comes from.

Behavior: Senders are ordered from newest to oldest. When both status and waba_id are specified, a sender must match both filters.

Requires: Your account must have WhatsApp enabled, must have a subscription plan, and must not be blocked or suspended.

get/v1/whatsapp/senders

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/whatsapp/senders
  • Auth
    HTTP bearer

Query parameters

status'banned' | 'connected' | 'deleted' | 'disconnected' | 'flagged' | 'migrated' | 'pending' | 'rate_limited' | 'restricted' | 'unknown' | 'unverified'

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.
waba_idstring

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

pageinteger

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

per_pageinteger

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

Response

A paginated list of WhatsApp senders.

Example response

{
  "senders": [
    {
      "phone_number": "+14155550100",
      "display_name": "Acme Support",
      "status": "connected",
      "quality_rating": "high",
      "waba": {
        "id": "102290129340398",
        "name": "Acme Support"
      }
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Changes