Skip to main content
GET
/
user
/
whatsapp
/
senders
curl -X GET "https://call.aiployees.com/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": 12,
      "phone_number": "+14155551234",
      "display_name": "Acme Corp Support",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": 10000,
      "messaging_limit_formatted": "10,000 / 24hr"
    },
    {
      "id": 15,
      "phone_number": "+442071234567",
      "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
curl -X GET "https://call.aiployees.com/api/user/whatsapp/senders" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": 12,
      "phone_number": "+14155551234",
      "display_name": "Acme Corp Support",
      "status": "online",
      "quality_rating": "GREEN",
      "messaging_limit": 10000,
      "messaging_limit_formatted": "10,000 / 24hr"
    },
    {
      "id": 15,
      "phone_number": "+442071234567",
      "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.