API Reference
The Vobiz WhatsApp API allows you to programmatically send messages, manage contacts, create campaigns, and integrate WhatsApp communication into your applications.
API Features
RESTful Design
Intuitive, predictable endpoints
Secure Authentication
Token-based access control
JSON Responses
Easy to parse and integrate
Comprehensive Docs
Detailed examples for all endpoints
Base URL
All API requests should be made to the following base URL:
https://api.vobiz.com/v1/messaging/API Versioning
The API version is included in the URL path (/v1/). When we release breaking changes, we'll create a new version (v2, v3, etc.) while maintaining support for older versions.
Authentication
The Vobiz API uses header-based authentication with two required headers for every request:
X-Auth-ID
Your account's authentication ID, found in the Vobiz console under Settings → API Keys
X-Auth-Token
Your secret authentication token. Keep this secure and never expose it in client-side code.
Example Request
curl -X POST https://api.vobiz.com/v1/messaging/send \
-H "X-Auth-ID: your_auth_id" \
-H "X-Auth-Token: your_auth_token" \
-H "Content-Type: application/json" \
-d '{
"channel_id": "ch_abc123",
"to": "+1234567890",
"type": "text",
"text": {
"body": "Hello from Vobiz API!"
}
}'🔒 Security Best Practices
- • Never commit API credentials to version control
- • Use environment variables to store credentials
- • Rotate your tokens periodically
- • Only make API calls from server-side code, never from browsers
- • Use HTTPS for all API requests (HTTP is not supported)
API Endpoints
The Vobiz API is organized into logical endpoint groups:
Channels
Manage WhatsApp Business channels
/channelsCreate channel/channelsList channels/channels/:idUpdate channel/channels/:idDelete channelSDKs & Libraries
Official SDKs make it easier to integrate the Vobiz API into your applications:
Community SDKs
Don't see your language? The Vobiz API is a standard REST API that works with any HTTP client. Community-maintained SDKs for other languages may be available.
Rate Limits
To ensure fair usage and system stability, the Vobiz API enforces rate limits:
1000
requests per minute
Per API key
100K
requests per hour
Per API key
1M
requests per day
Per API key
Rate Limit Headers
Every API response includes headers with rate limit information:
X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 987 X-RateLimit-Reset: 1710849600
⚠️ What Happens When Rate Limited?
If you exceed the rate limit, you'll receive a 429 Too Many Requests response with a Retry-After header indicating when you can retry.
Implement exponential backoff in your application to handle rate limits gracefully.
Best Practices
✓ Use Idempotency Keys
For operations that create resources (POST requests), include an Idempotency-Key header to safely retry requests without creating duplicates.
✓ Handle Errors Gracefully
Always check response status codes and handle errors appropriately. Implement retry logic with exponential backoff for transient failures.
✓ Use Webhooks for Real-time Updates
Instead of polling the API for message status updates, use webhooks to receive real-time notifications. This is more efficient and provides instant updates.
✓ Cache When Appropriate
Cache responses for data that doesn't change frequently (like templates or channel details) to reduce API calls and improve application performance.