Template Message

WhatsApp requires businesses to use pre-approved templates for initiating conversations. This API allows you to send template messages with personalized variables, media attachments, and interactive components to your customers.

OverviewCopy Anchor Link

The Send Template Message API enables you to:

• Send WhatsApp messages using your pre-approved templates
• Dynamically replace variables with personalized content
• Attach media (images, videos, documents) when supported by the template
• Include interactive elements like buttons and quick replies
• Track delivery status through WhatsApp response information

Send Template MessageCopy Anchor Link

Send a personalized WhatsApp template message to a specific phone number.

EndpointCopy Anchor Link

POST https://api.insightssystem.com/api:hFrjh8a1/send_template_message_by_api

AuthenticationCopy Anchor Link

Include your API key in all requests using Bearer authentication:

Authorization: Bearer YOUR_API_KEY

Request BodyCopy Anchor Link

ResponseCopy Anchor Link

The API returns a detailed response indicating whether the message was accepted for delivery and provides WhatsApp message identifiers for tracking.

Example RequestCopy Anchor Link

curl -X POST \
  'https://api.insightssystem.com/api:hFrjh8a1/send_template_message_by_api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "template": "f10695a9-38d6-4f5f-8444-1f7bf52c6164",
    "phone_number": "+123476529999",
    "variables": {
      "body1": "Axel",
      "body2": "Shampoo",
      "body3": "$1",
      "media": "https://drive.google.com/file/d/1D35uTbceRPmCgwxVfBJZ2yxD2lQgs0bi/view?usp=sharing",
      "visit_website": "1"
    }
  }'

Example ResponseCopy Anchor Link

{
  "success": true,
  "whatsapp_response_info": {
    "messaging_product": "whatsapp",
    "contacts": [
      {
        "input": "+123476529999",
        "wa_id": "123476529999"
      }
    ],
    "messages": [
      {
        "id": "wamid.HBgLMTIzNDc2NTI5OTk5FQIAERgSNUU2RjM4NzM1M0Q5OEIwQTQwAA==",
        "message_status": "accepted"
      }
    ]
  }
}

Response CodesCopy Anchor Link

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: template"
  }
}

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided"
  }
}

{
  "success": false,
  "error": {
    "code": "template_not_found",
    "message": "Template with ID 'f10695a9-38d6-4f5f-8444-1f7bf52c6164' not found"
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_phone_number",
    "message": "The phone number format is invalid"
  }
}

{
  "success": false,
  "error": {
    "code": "server_error",
    "message": "An internal server error occurred"
  }
}

Working with Template VariablesCopy Anchor Link

Templates contain placeholders that are replaced with dynamic content when sending messages. Understanding how to map your data to these variables is essential.

Variable TypesCopy Anchor Link

Variable MappingCopy Anchor Link

Media GuidelinesCopy Anchor Link

When including media in your templates, follow these guidelines for optimal delivery:

Best PracticesCopy Anchor Link

FAQsCopy Anchor Link