Skip to main content
POST
/
v1
/
messaging
/
messages
Send Message API
curl --request POST \
  --url https://api.example.com/v1/messaging/messages

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.

Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json
This endpoint supports all WhatsApp message types: text, image, video, audio, document, location, contacts, and template messages.

​
Endpoint

POST https://api.vobiz.ai/v1/messaging/messages

​
Sending Text Messages

Send plain text messages to your customers. Text messages can be up to 4,096 characters.

​
Text Object Properties

PropertyTypeDescription
bodystringMessage content (max 4,096 characters)
preview_urlbooleanShow URL preview if message contains links (optional, default: false)
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/messages" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "{channel_id}",
    "to": "+919876543210",
    "type": "text",
    "text": { "body": "Hello from Vobiz!" }
  }'

​
Sending Media Messages

Send images, videos, or documents with optional captions.

​
Media Object Properties

PropertyTypeDescription
urlstringPublic URL of the media file
captionstringOptional caption (max 1,024 characters)
filenamestringOptional filename (for documents)
cURL - image example
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/messages" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "{channel_id}",
    "to": "+919876543210",
    "type": "image",
    "image": {
      "url": "https://example.com/photo.jpg",
      "caption": "Check this out!"
    }
  }'

​
Media File Requirements

  • Images - JPG, PNG. Max 5MB.
  • Videos - MP4, 3GPP. Max 16MB.
  • Documents - PDF, DOC, XLSX, etc. Max 100MB.
  • Hosting - Media must be publicly accessible via HTTPS URL.

​
Sending Template Messages

Send pre-approved template messages for marketing, authentication, or utility purposes.

​
Template Object Properties

PropertyTypeDescription
namestringTemplate name from Meta Business Manager
languagestringLanguage code (e.g., en, es, pt_BR)
parametersarrayArray of parameter objects for template variables
Templates must be created and approved in Meta Business Manager before you can use them. See our Templates Guide for details.
cURL - template example
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/messages" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "{channel_id}",
    "to": "+919876543210",
    "type": "template",
    "template": {
      "name": "order_confirmation",
      "language": { "code": "en_US" },
      "components": [{
        "type": "body",
        "parameters": [
          { "type": "text", "text": "ORD-12345" },
          { "type": "text", "text": "March 15" }
        ]
      }]
    }
  }'

​
Response

​
Success Response (200 OK)

{
  "id": "msg_abc123def456",
  "channel_id": "ch_xyz789",
  "conversation_id": "conv_123abc",
  "to": "+919876543210",
  "type": "text",
  "status": "sent",
  "timestamp": "2026-03-19T10:30:00Z"
}

​
Common Error Codes

  • INVALID_NUMBER - Phone number format is invalid or not on WhatsApp.
  • INVALID_CHANNEL - Channel ID does not exist or is not active.
  • TEMPLATE_NOT_FOUND - Template does not exist or has not been approved.
  • RATE_LIMIT_EXCEEDED - Too many messages sent, retry after cooldown.