Skip to main content
This reference covers the Vobiz WhatsApp Business API. For programmable voice, SIP trunks, phone numbers, recordings, and account APIs, use the main Vobiz API reference.

​
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:

​
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.
A JWT obtained at login is also accepted via the 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 (HTTP is not supported).
View Full Authentication Guide →

​
API Endpoints

The Vobiz API is organized into logical endpoint groups. All paths are relative to the base URL https://api.vobiz.ai/api/v1/messaging.

​
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 →

​
Realtime

Connect to the realtime WebSocket for live message and conversation updates:

​
API Documentation