Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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.ai/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.

​
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).
View Full Authentication Guide →

​
API Endpoints

The Vobiz API is organized into logical endpoint groups:

​
Messaging

Send and manage WhatsApp messages.
MethodPathDescription
POST/sendSend a message
View Messaging API →

​
Channels

Manage WhatsApp Business channels.
MethodPathDescription
POST/channelsCreate channel
GET/channelsList channels
PUT/channels/:idUpdate channel
DELETE/channels/:idDelete channel
View Channels API →

​
Numbers

Search, purchase, and verify WhatsApp numbers (4 endpoints). View Numbers API →

​
Conversations

List conversations and paginate message history (2 endpoints). View Conversations API →

​
Contacts

CRUD contacts and bulk import from CSV (6 endpoints). View Contacts API →

​
Templates

List, create, and sync Meta-approved message templates (3 endpoints). View Templates API →

​
Campaigns

Create and manage broadcast campaigns to segmented audiences (7 endpoints). View Campaigns API →

​
Canned Responses

Manage saved reply shortcuts for agents (3 endpoints). View Canned Responses API →

​
Calls

Initiate and manage WhatsApp voice calls (3 endpoints). View Calls API →

​
Webhooks

Meta webhook verification and Vobiz subscription management (5 endpoints). View Webhooks API →

​
SDKs & Libraries

Official SDKs make it easier to integrate the Vobiz API into your applications:
  • Python SDK - pip install vobiz
  • Node.js SDK - npm install @vobiz/sdk
  • PHP SDK - composer require vobiz/sdk
  • Ruby SDK - gem install vobiz

​
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 the following rate limits per API key:
  • 1,000 requests per minute
  • 100,000 requests per hour
  • 1,000,000 requests per day

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

​
API Documentation