WhatsApp API Documentation

Overview

The Commersio WhatsApp API allows you to send WhatsApp messages programmatically. You can send both plain text messages and template-based messages to your customers.

Features

• Send text messages to WhatsApp numbers
• Send template-based messages with variables
• Retrieve available message templates
• Get message history and contacts
• Secure API key authentication
• Rate limiting and error handling

Authentication

All API requests require authentication using an API key. You can generate your API key from the API Integration page in your dashboard.

API Key Format

API keys are 64-character hexadecimal strings

Authentication Methods

Include your API key in the request headers using one of these methods:

curl -H "X-API-Key: your_api_key_here" \
     -H "Content-Type: application/json" \
     https://glowquill.com/api/external/templates

curl -H "Authorization: Bearer your_api_key_here" \
     -H "Content-Type: application/json" \
     https://glowquill.com/api/external/templates

Send Message

Send WhatsApp messages using either plain text or templates.

Send Text Message

curl -X POST "https://glowquill.com/api/external/whatsapp/send" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "text": "Hello! This is a test message."
  }'

Send Template Message

curl -X POST "https://glowquill.com/api/external/whatsapp/send" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "template_name": "order_confirmation",
    "template_variables": {
      "1": "John Doe",
      "2": "ORD12345"
    }
  }'

Parameters

* Either text or template_name is required

Response

{
  "success": true,
  "message": "Message sent successfully",
  "message_id": "wamid.HBgNMTIzNDU2Nzg5MAA="
}

🤖 Chatbot System

Automated chatbots respond to customer messages using keyword triggers and AI fallback. Bots automatically pause when human agents are actively chatting.

Get Templates

Retrieve all available message templates for your account.

Request

curl -X GET "https://glowquill.com/api/external/templates" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Response

[
  {
    "_id": "60f7b3b3b3b3b3b3b3b3b3b3",
    "name": "order_confirmation",
    "language": "en",
    "category": "UTILITY",
    "status": "APPROVED"
  }
]

Additional Endpoints

curl -X GET "https://glowquill.com/api/external/messages" \
  -H "X-API-Key: your_api_key_here"

curl -X GET "https://glowquill.com/api/external/contacts" \
  -H "X-API-Key: your_api_key_here"

Error Handling

The API uses conventional HTTP response codes to indicate success or failure.

HTTP Status Codes

Error Response Format

{
  "error": "Invalid API key"
}

Postman Collection

Download our Postman collection to quickly test all API endpoints with pre-configured requests.

Quick Setup

1. Download the collection JSON file above
2. Open Postman and click "Import"
3. Select the downloaded JSON file
4. Set the EXTERNAL_BASE_URL variable to https://glowquill.com/api/external
5. Set the API_KEY variable to your generated API key
6. Start testing the endpoints!

Collection Contents