Convers8 Developers

Appearance

WABA Messaging ​

Convers8 provides a comprehensive set of WhatsApp Business API (WABA) messaging endpoints that allow you to send various types of messages to your customers. This guide provides an overview of the available message types and links to detailed documentation for each.

Authentication ​

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL ​

https://waba-v1.convers8.africa

Message Types ​

Convers8 supports the following message types:

Text Messages ​

Send simple text messages to your WhatsApp contacts.

Example:

json
{
  "to": "+1234567890",
  "name": "Customer Name",
  "content": {
    "text": "Hello from Convers8!"
  }
}

Learn more about Text Messages →

Media Messages ​

Send various types of media, including images, audio, video, and documents.

Example:

json
{
  "to": "+1234567890",
  "name": "Customer Name",
  "content": {
    "url": "https://example.com/image.jpg",
    "caption": "Check out this image!"
  }
}

Learn more about Media Messages →

Interactive Messages ​

Send interactive messages with lists and buttons for enhanced user engagement.

Example:

json
{
  "to": "+1234567890",
  "name": "Customer Name",
  "content": {
    "type": "button",
    "header": {
      "type": "text",
      "text": "Feedback Request"
    },
    "body": {
      "text": "How would you rate our service?"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "rating_good",
            "title": "Good"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "rating_average",
            "title": "Average"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "rating_poor",
            "title": "Poor"
          }
        }
      ]
    }
  }
}

Learn more about Interactive Messages →

Template Messages ​

Send pre-approved message templates with dynamic variables.

Example:

json
{
  "to": "+1234567890",
  "name": "Customer Name",
  "templateName": "order_confirmation",
  "language": "en_US",
  "components": [
    {
      "type": "header",
      "parameters": [
        {
          "type": "text",
          "text": "Order Confirmation"
        }
      ]
    },
    {
      "type": "body",
      "parameters": [
        {
          "type": "text",
          "text": "123456"
        },
        {
          "type": "text",
          "text": "Convers8 Store"
        },
        {
          "type": "text",
          "text": "$99.99"
        }
      ]
    }
  ]
}

Learn more about Template Messages →

Response Format ​

All API endpoints return a JSON response with the following structure:

json
{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "messageId": "wamid.abcdefghijklmnopqrstuvwxyz"
  }
}

In case of an error, the response will look like:

json
{
  "success": false,
  "message": "Error message",
  "error": {
    "code": "error_code",
    "details": "Error details"
  }
}

Best Practices ​

  1. Rate Limiting: Be mindful of WhatsApp's rate limits to avoid being blocked.
  2. Message Templates: Use message templates for outbound notifications to ensure compliance with WhatsApp policies.
  3. Media Size: Keep media files within WhatsApp's size limits (image: 5MB, video: 16MB, audio: 16MB, document: 100MB).
  4. Error Handling: Implement proper error handling to manage failed message deliveries.
  5. Webhooks: Set up webhooks to receive delivery status updates for your messages.

API Reference ​

For detailed API reference and interactive testing, visit the API Reference section.