Sign in
WhatsApp

Retrieve a WhatsApp sender

Returns the WhatsApp sender registered for the given phone number on the authenticated account.

get/v1/whatsapp/senders/{number}

Path parameters

numberstring required
Example:14155550100

Sender's phone number, digits only.

Response

The requested WhatsApp sender.

phone_numberstring required

Sender's phone number in E.164 format.

display_namestring nullable

Sender's WhatsApp display name.

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

Sender registration status with the provider.

quality_rating'high' | 'medium' | 'low' | 'unknown' | 'null' nullable

Sender's messaging quality rating.

message_tier'limit_na' | 'limit_250' | 'limit_2k' | 'limit_10k' | 'limit_100k' | 'unlimited' | 'null' nullable

Sender's 24-hour outbound messaging limit tier.

Example response

{
  "phone_number": "+14155550100",
  "display_name": "Wavix",
  "status": "connected",
  "quality_rating": "high",
  "message_tier": "limit_2k"
}

Changes

Changed in 1 of the 55 revisions of this API.1