WABA Numbers
API for viewing and managing linked WhatsApp Business numbers
Reading time: 2 minutes
WABA Numbers
View and manage WhatsApp Business numbers linked to your account.
Get WABA Numbers List
GET
{{base_url}}/waba-numbersView all connected WhatsApp Business numbers.
Example Request
Example Requestbash
curl -X GET "https://api.awalchat.com/api/developer/waba-numbers" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id"Example Response
Response200 OK
{
"status": true,
"data": [
{
"id": 1,
"phone_number": "96650000000",
"phone_number_id": "123456789012345",
"verified_name": "My Business",
"quality_rating": "GREEN",
"status": "CONNECTED",
"message_template_count": 25,
"created_at": "2024-01-10T10:00:00Z",
"updated_at": "2024-01-20T14:30:00Z"
},
{
"id": 2,
"phone_number": "96650000001",
"phone_number_id": "987654321098765",
"verified_name": "Another Business",
"quality_rating": "YELLOW",
"status": "CONNECTED",
"message_template_count": 10,
"created_at": "2024-01-15T11:00:00Z",
"updated_at": "2024-01-18T09:15:00Z"
}
]
}Field Information
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | No | Number ID in the system |
phone_number | string | No | Phone number in international format |
phone_number_id | string | No | Number ID in Meta (used in API) |
verified_name | string | No | Verified name from Meta |
quality_rating | string | No | Quality rating: GREEN, YELLOW, RED |
status | string | No | Connection status: CONNECTED, DISCONNECTED |
message_template_count | integer | No | Number of approved templates |
Important Notes
ā
Quality Rating
GREEN- Excellent quality, no issuesYELLOW- Medium quality, may need improvementRED- Low quality, number may be suspended
ā ļø
Connection Status
CONNECTED- Connected and working normallyDISCONNECTED- Not connected, check connection settings
š”
phone_number_id
- This ID is required in all API requests
- Use it in
phone_number_idparameter in all requests - Keep it secure and don't share it
Use Cases
1. Get phone_number_id
// Get numbers list
const numbers = await getWabaNumbers();
// Use phone_number_id in requests
const phoneNumberId = numbers.data[0].phone_number_id;
// Use it in API request
await sendMessage(phoneNumberId, {
phone: "96650000000",
body: "Hello"
});2. Check Number Status
const numbers = await getWabaNumbers();
const number = numbers.data[0];
if (number.status === 'CONNECTED' && number.quality_rating === 'GREEN') {
console.log('Number is ready to use');
} else {
console.warn('Check number status');
}Error Codes
| Code | Description | Cause | Solution |
|---|---|---|---|
| 401 | Unauthorized | Invalid authentication | Check authentication |
| 404 | Not Found | No connected numbers | Check WhatsApp settings |
Related Sections
Technical Support
Need help?
- š§ Email: support@awalchat.com
- š¬ Live Chat: Available in the dashboard
- š± WhatsApp: Contact us directly via WhatsApp
- š Examples: Check Code Examples