Get WhatsApp Senders

List all WhatsApp Business senders for the authenticated user

GET /user/whatsapp/senders

cURL

curl -X GET "https://app.cloudone-ai.com/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "data": [
    {
      "id": 12,
      "phone_number": "[phone]",
      "display_name": "Acme Corp Support",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": 10000,
      "messaging_limit_formatted": "10,000 / 24hr"
    },
    {
      "id": 15,
      "phone_number": "[phone]",
      "display_name": "Acme Corp Sales",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": null,
      "messaging_limit_formatted": "Unlimited"
    }
  ]
}

This endpoint returns a list of WhatsApp Business senders (phone numbers) configured for your account. Use this to retrieve sender IDs needed for sending messages.

Query Parameters

status · string

Filter senders by status. Default: online. Use all to return all senders regardless of status.

Response Fields

data · array

Show Sender object properties

id · integer

The unique identifier of the WhatsApp sender. Use this ID when sending messages.

phone_number · string

The sender’s phone number in E.164 format (e.g., [phone])

display_name · string

The WhatsApp Business display name (business name shown to recipients)

status · string

The sender’s current status: online or offline

quality_rating · string

Meta’s quality rating for this sender: GREEN, YELLOW, or RED

messaging_limit · integer

The current messaging limit (number of unique recipients per 24 hours). null means unlimited.

messaging_limit_formatted · string

Human-readable messaging limit (e.g., 1,000 / 24hr, 10,000 / 24hr, or Unlimited)

cURL

curl -X GET "https://app.cloudone-ai.com/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "data": [
    {
      "id": 12,
      "phone_number": "[phone]",
      "display_name": "Acme Corp Support",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": 10000,
      "messaging_limit_formatted": "10,000 / 24hr"
    },
    {
      "id": 15,
      "phone_number": "[phone]",
      "display_name": "Acme Corp Sales",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": null,
      "messaging_limit_formatted": "Unlimited"
    }
  ]
}

Notes

• Only senders with status online are returned by default. Use ?status=all to include offline senders.
• Sender status is synced with Meta every 5 minutes automatically.
• The id field is what you need to pass as sender_id when sending messages.
• Quality rating affects your messaging limits. A RED rating may restrict your ability to send messages.