API Features
- RESTful design - Intuitive, predictable endpoints.
- Secure authentication - Header-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:{auth_id} with your Auth ID (MA_XXXXXXXX). It must be the account your credentials belong to, otherwise the request returns 403.
Paths follow the same conventions as the Voice Call API:
- Case-sensitive. Write
Account,WhatsAppand each resource name exactly as shown. A lowercase/whatsapp/in this position returns404. - Trailing slash optional.
/Messageand/Message/reach the same endpoint. - Meta webhooks stay where they are. The inbound Meta callback URL,
https://api.vobiz.ai/api/v1/webhooks/whatsapp, is shared by all accounts and does not change.
The earlier URLs under
https://api.vobiz.ai/api/v1/messaging (for example POST /api/v1/messaging/messages) still work and return the same responses. Use the account-scoped URLs above for new integrations.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 (MA_…), found in the Vobiz Console under Settings → API.X-Auth-Token- Your secret authentication token. Keep this secure and never expose it in client-side code.
Authorization: Bearer <token> header.
Security Best Practices
- Never commit API credentials to version control.
- Use environment variables to store credentials.
- Only make API calls from server-side code, never from browsers.
- Use HTTPS for all API requests.
API Endpoints
The Vobiz API is organized into logical endpoint groups. All paths are relative to the base URLhttps://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp.
Messaging
Send WhatsApp messages.
View Messaging API →
Channels
Manage WhatsApp Business channels.
View Channels API →
Numbers
Search, order, and verify WhatsApp numbers.
View Numbers API →
Conversations
List conversations and paginate message history.
View Conversations API →
Contacts
CRUD contacts and bulk import from CSV.
View Contacts API →
Templates
List, create, and sync Meta-approved message templates.
View Templates API →
Campaigns
Create and manage broadcast campaigns to segmented audiences.
View Campaigns API →
Canned Responses
Manage saved reply shortcuts for agents.
View Canned Responses API →
Calls
Initiate and manage WhatsApp voice calls.
View Calls API →
Webhook Subscriptions
Manage Vobiz webhook subscriptions.
View Webhooks API →