Skip to main content
GET
Retrieve a WhatsApp sender

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.

Path Parameters

​
number
string
required

Phone number of a sender on your account, in E.164 format, as returned in phone_number by whatsapp_senders_list. The leading + is optional.

Pattern: ^\+?\d{6,20}$

Response

The requested WhatsApp sender.

A WhatsApp sender, which is a phone number registered with WhatsApp in one of your account's WhatsApp Business Accounts. Returned by whatsapp_senders_list and whatsapp_senders_get.

​
phone_number
string
required

Sender's phone number in E.164 format.

Example:

"+14155550100"

​
display_name
string | null
required

Sender's WhatsApp display name.

Example:

"Acme Support"

​
status
enum<string>
required

Sender registration status with the provider. 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
Example:

"connected"

​
quality_rating
enum<string> | null
required

Sender's messaging quality rating. Meta rates quality from customer feedback over the past seven days, such as blocks and reports. Possible values:

  • high — High quality.
  • medium — Medium quality.
  • low — Low quality.
  • unknown — Not rated yet.
Available options:
high,
medium,
low,
unknown,
null
Example:

"high"

​
message_tier
enum<string> | null
required

Sender's 24-hour outbound messaging limit tier. Possible values:

  • limit_na — No limit is set.
  • limit_250 — Up to 250 unique customers.
  • limit_2k — Up to 2,000 unique customers.
  • limit_10k — Up to 10,000 unique customers.
  • limit_100k — Up to 100,000 unique customers.
  • unlimited — No limit on unique customers.
Available options:
limit_na,
limit_250,
limit_2k,
limit_10k,
limit_100k,
unlimited,
null
Example:

"limit_2k"

​
waba
WhatsAppWaba · object
required

A WhatsApp Business Account linked to your account, embedded in senders and templates.