Skip to main content

​
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: 
https://api.vobiz.ai/api/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 (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.
MethodPathDescription
POST/messagesSend a message
View Messaging API →

​
Channels

Manage WhatsApp Business channels.
MethodPathDescription
POST/channels/whatsappCreate channel
GET/channels/whatsappList channels
POST/channels/whatsapp/embedded-signupComplete embedded signup
PUT/channels/whatsapp/{id}Update channel
DELETE/channels/whatsapp/{id}Delete channel
View Channels API →

​
Numbers

Search, order, and verify WhatsApp numbers.
MethodPathDescription
GET/numbers/whatsapp/availabilityCheck number availability
POST/numbers/whatsapp/ordersOrder a WhatsApp number
POST/numbers/whatsapp/bring-your-own/verifyVerify a BYON number
POST/numbers/whatsapp/bring-your-own/confirmConfirm a BYON number
View Numbers API →

​
Conversations

List conversations and paginate message history.
MethodPathDescription
GET/conversationsList conversations
GET/conversations/{id}/messagesList messages in a conversation
View Conversations API →

​
Contacts

CRUD contacts and bulk import from CSV.
MethodPathDescription
GET/contactsList contacts
GET/contacts/{id}Get a contact
POST/contactsCreate a contact
PUT/contacts/{id}Update a contact
DELETE/contacts/{id}Delete a contact
POST/contacts/importBulk import contacts
View Contacts API →

​
Templates

List, create, and sync Meta-approved message templates.
MethodPathDescription
GET/channels/{channelId}/templatesList templates
POST/channels/{channelId}/templatesCreate a template
POST/channels/{channelId}/templates/syncSync templates from Meta
View Templates API →

​
Campaigns

Create and manage broadcast campaigns to segmented audiences.
MethodPathDescription
GET/campaignsList campaigns
POST/campaignsCreate a campaign
GET/campaigns/{id}Get a campaign
POST/campaigns/{id}/pausePause a campaign
POST/campaigns/{id}/resumeResume a campaign
POST/campaigns/{id}/cancelCancel a campaign
DELETE/campaigns/{id}Delete a campaign
GET/campaigns/{id}/recipientsList campaign recipients
View Campaigns API →

​
Canned Responses

Manage saved reply shortcuts for agents.
MethodPathDescription
GET/canned-responsesList canned responses
POST/canned-responsesCreate a canned response
DELETE/canned-responses/{id}Delete a canned response
View Canned Responses API →

​
Calls

Initiate and manage WhatsApp voice calls.
MethodPathDescription
POST/calls/whatsappInitiate a WhatsApp call
POST/calls/whatsapp/actionPerform a call action
GET/calls/whatsapp/logsList call logs
View Calls API →

​
Webhook Subscriptions

Manage Vobiz webhook subscriptions.
MethodPathDescription
POST/webhooksCreate a webhook subscription
GET/webhooksList webhook subscriptions
DELETE/webhooks/{id}Delete a webhook subscription
View Webhooks API →

​
Realtime

Connect to the realtime WebSocket for live message and conversation updates: 
wss://api.vobiz.ai/api/v1/messaging/ws

​
API Documentation