What is the WhatsApp Business API 24-hour window?

The 24-hour window is a conversation-based pricing model where businesses can send free-form messages within 24 hours of the last customer message. Outside this window, you must use pre-approved template messages.

How much does Chatmitra charge for WhatsApp Business API?

Chatmitra charges competitive rates for WhatsApp Business API usage based on Meta's official pricing. Marketing, utility, and authentication templates have different pricing tiers. View official Meta pricing at https://developers.facebook.com/docs/whatsapp/pricing

Chat Mitra WhatsApp API

Send WhatsApp messages, templates, and rich media directly from your application. Integrate in minutes with comprehensive REST API and real-time delivery tracking.

REST API

v1.0.0

Bearer Token Auth

HTTPS Secure

Real-Time Queue

Fast Delivery

Understanding Chat Mitra API

Chat Mitra provides a simple, powerful REST API for sending WhatsApp messages at scale. Whether you're building customer support chatbots, marketing automation, or order notifications, our API handles it all with enterprise-grade reliability. This guide covers WhatsApp API integration basics for beginners to advanced developers.

What You Can Do

Send text messages, templates, and rich media (images, videos, documents, audio)
Send interactive messages with buttons and dropdown lists
Batch send to multiple customers in single API call
Track delivery status in real-time with detailed reporting
Use dynamic templates with customer-specific placeholders

Key Concepts

Conversations

A 24-hour messaging window between you and one customer. First message to a new customer initiates a conversation (costs 1 credit, approx. ₹0.20 based on region), then unlimited free messages within the 24-hour window. Why this matters: This ensures compliance with WhatsApp's user-initiated conversation rules, reducing spam risks. Think of it like a timed chat session—start one, then chat freely until it expires.

Message Types

Text, Templates, Images, Videos, Documents, Audio, Location, Contacts, Interactive (Buttons/Lists), Reactions, and Stickers. Each has specific validation rules. What this means: Choose based on your use case, like text for simple notifications or interactive for user responses.

Raw Messages

Raw messages (also known as free-form or session messages) include custom text, media, interactive elements, and more. They can only be sent within an active 24-hour customer service window, which starts when the customer initiates contact (e.g., sends the first message). These messages are free of charge within the window, as per Meta's policies—no per-message fees apply. Why use raw messages: They allow flexible, personalized communication during active conversations without additional costs.

Template Messages

Template messages are pre-approved formats with dynamic placeholders for personalization. They can be sent at any time, including to initiate new conversations or re-engage outside the 24-hour window. Templates are charged per delivered message based on category (marketing, utility, authentication) and recipient's country/region, as per Meta's pricing (effective July 2025). Utility templates are free when sent within an active window; marketing and authentication templates are charged regardless. Why use templates: They enable proactive outreach while complying with WhatsApp rules, like pre-filled forms for quick, scalable messaging.

Templates

Pre-approved WhatsApp message formats with dynamic placeholders. Create and manage in your dashboard. Templates are reusable, faster to send, and cost-effective. Why use templates: They bypass content review for each message, enabling faster sends and lower costs—like pre-filled forms for quick personalization.

Queue System

Messages are queued and processed asynchronously for guaranteed delivery. API returns immediately with job ID for tracking. Retry logic handles transient failures automatically. Why this matters: Ensures reliability even during high traffic, like a buffer in a busy restaurant kitchen.

Required Headers & Authentication

bash

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Base URL

https://backend.chatmitra.com/developer/api

Authentication

Bearer Token in Authorization Header

Send Raw Messages

Send immediate text, media, and interactive messages via WhatsApp Business API. Perfect for real-time communication within the 24-hour conversation window.

POST /send_message

The primary endpoint for sending WhatsApp messages. Accepts text, templates, media, and interactive messages. Queues messages for reliable delivery.

Why use this endpoint: It's the core for all WhatsApp API integration, handling everything from simple texts to complex interactions in real-time.

Raw Messages Require Active 24-Hour Window

Raw messages (text, media, interactive) can only be sent when a 24-hour conversation window is active. This window opens when a customer sends you a message and lasts for 24 hours from their last message.

Inside 24-hour window: Send any raw message type freely
Outside 24-hour window: Must use Template Messages only
Window resets: Every incoming customer message restarts the 24-hour countdown
Failure scenario: Sending raw messages outside the window returns error code 131026

When to Use Raw Messages vs Templates

Use Raw Messages For:

Customer support conversations
Real-time chatbot responses
Immediate media sharing (receipts, photos)
Interactive button responses
Any message within 24h of customer contact

Use Templates For:

First contact with customers
Messages outside 24-hour window
Marketing broadcasts
Appointment reminders (proactive)
Order confirmations (if no recent interaction)

Chatmitra Pricing & Conversation Costs

Raw messages sent within the 24-hour window are charged as part of conversation-based pricing. Chatmitra uses Meta's official WhatsApp Business API pricing with competitive platform fees.

Conversation Categories:

User-Initiated: Customer messages first (24h window opens) - Lower rate
Business-Initiated: You message first using Templates - Higher rate
Free Entry Points: Some customer entry points offer free 72-hour windows

Official Meta Pricing Reference:

https://developers.facebook.com/docs/whatsapp/pricing

View country-specific rates. Chatmitra adds a small platform fee on top of Meta's base rates. Raw messages within 24h window are typically charged as "User-Initiated Conversations."

Raw Message Best Practices

Always check if 24-hour window is active before sending raw messages
Use templates for the first message, then switch to raw messages after customer replies
Keep text messages under 1000 characters for optimal delivery
Compress media files to recommended sizes for faster sending
Use interactive buttons to encourage customer responses (resets 24h window)
Implement fallback to templates if raw message fails due to expired window

Raw messages (text, media, interactive) can only be sent when a 24-hour conversation window is active

This window opens when a customer sends you a message and lasts for 24 hours from their last message.

Simple Text Message

Send a basic text message. No setup required, works instantly. What this demonstrates: A straightforward way to send WhatsApp messages via REST API without templates or media.

Request

json

{
  "recipient_mobile_number": "919999999999",
  "message": "Hello! Your order #12345 is ready for pickup 📦"
}

Preview

Customer

online

Hello! Your order #12345 is ready for pickup 📦

Type a message

Preview of message sent to Customer

Full code examples to send this request in multiple languages. All examples use the same payload, handle errors, and are ready to run (replace 'YOUR_TOKEN' with your actual token).

python

import requests
import os
# Load environment variables
token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message')
payload = {
    "recipient_mobile_number": "919999999999",
    "message": "Hello! Your order #12345 is ready for pickup 📦"
}
headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}
try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status() # Raise error for bad status
    print(response.json()) # Expected: {'status': 'success', 'message': 'Request queued', 'jobId': 'job_abc123xyz789'}
except requests.exceptions.RequestException as e:
    print(f"Error: {e}") # Handle network or API errors

node.js

const axios = require('axios');
require('dotenv').config(); // Load .env
const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message';
const payload = {
  recipient_mobile_number: '919999999999',
  message: 'Hello! Your order #12345 is ready for pickup 📦'
};
const sendMessage = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data); // Expected: { status: 'success', message: 'Request queued', jobId: 'job_abc123xyz789' }
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message); // Handle errors
  }
};
sendMessage();

php

<?php
require 'vendor/autoload.php'; // Assuming Guzzle installed via Composer
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;
$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();
$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message';
$payload = [
    'recipient_mobile_number' => '919999999999',
    'message' => 'Hello! Your order #12345 is ready for pickup 📦'
];
$client = new Client();
try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents(); // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
public class SendMessage {
    public static void main(String[] args) throws IOException, InterruptedException {
        // Load token from env or properties file
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message";
        String payload = """
            {
                "recipient_mobile_number": "919999999999",
                "message": "Hello! Your order #12345 is ready for pickup 📦"
            }""";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();
        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body()); // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e; // Rethrow or handle
        }
    }
}

package main
import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)
func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message"
    }
    payload := []byte(`{
        "recipient_mobile_number": "919999999999",
        "message": "Hello! Your order #12345 is ready for pickup 📦"
    }`)
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }
    fmt.Println(string(body)) // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load' # gem install dotenv
token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message'
payload = {
  recipient_mobile_number: '919999999999',
  message: 'Hello! Your order #12345 is ready for pickup 📦'
}.to_json
uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body # Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "message": "Hello! Your order #12345 is ready for pickup 📦"
  }' # Expected output: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.IO;
class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message";
        string payload = @"
        {
            ""recipient_mobile_number"": ""919999999999"",
            ""message"": ""Hello! Your order #12345 is ready for pickup 📦""
        }";
        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");
            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody); // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation
let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message"
guard let url = URL(string: urlString) else { return }
let payload: [String: Any] = [
    "recipient_mobile_number": "919999999999",
    "message": "Hello! Your order #12345 is ready for pickup 📦"
]
do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
   
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
   
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString) // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException
fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message"
    val payload = """
        {
            "recipient_mobile_number": "919999999999",
            "message": "Hello! Your order #12345 is ready for pickup 📦"
        }
    """.trimIndent()
    val client = OkHttpClient()
    val requestBody = payload.toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()
    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string()) // Expected: {"status":"success","message":"Request queued","jobId":"job_abc123xyz789"}
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Response (202)

json

{
  "status": "success",
  "message": "Request queued",
  "jobId": "job_abc123xyz789"
}

Message Sent Successfully

Your message is queued and will be delivered within 5-30 seconds. The jobId can be used to track delivery status. Note: Check dashboard for status using jobId, or implement webhooks for real-time updates (see API Reference for best practices).

Send Image

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "image",
        "image": {
          "link": "https://cloudinary.com/product-image.jpg",
          "caption": "Check out our new product!"
        }
      }
    }
  ]
}

Preview

Customer

online

Check out our new product!

Type a message

Preview of message sent to Customer

Full code examples to send this image message in multiple languages. All examples use the same payload, handle errors, and are ready to run.

python

import requests
import os

token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message')

payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "image",
        "image": {
          "link": "https://cloudinary.com/product-image.jpg",
          "caption": "Check out our new product!"
        }
      }
    }
  ]
}

headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();

const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message';

const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'image',
        image: {
          link: 'https://cloudinary.com/product-image.jpg',
          caption: 'Check out our new product!'
        }
      }
    }
  ]
};

const sendImage = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};

sendImage();

php

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message';

$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'image',
        'image' => [
          'link' => 'https://cloudinary.com/product-image.jpg',
          'caption' => 'Check out our new product!'
        ]
      ]
    ]
  ]
];

$client = new Client();

try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;

public class SendImage {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message";

        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "image",
                    "image": {
                      "link": "https://cloudinary.com/product-image.jpg",
                      "caption": "Check out our new product!"
                    }
                  }
                }
              ]
            }""";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message"
    }

    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "image",
            "image": {
              "link": "https://cloudinary.com/product-image.jpg",
              "caption": "Check out our new product!"
            }
          }
        }
      ]
    }`)

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'

token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message'

payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'image',
        image: {
          link: 'https://cloudinary.com/product-image.jpg',
          caption: 'Check out our new product!'
        }
      }
    }
  ]
}.to_json

uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload

begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "image",
        "image": {
          "link": "https://cloudinary.com/product-image.jpg",
          "caption": "Check out our new product!"
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message";

        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""image"",
                ""image"": {
                  ""link"": ""https://cloudinary.com/product-image.jpg"",
                  ""caption"": ""Check out our new product!""
                }
              }
            }
          ]
        }";

        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");

            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation

let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message"

guard let url = URL(string: urlString) else { return }

let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "image",
        "image": [
          "link": "https://cloudinary.com/product-image.jpg",
          "caption": "Check out our new product!"
        ]
      ]
    ]
  ]
]

do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException

fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message"

    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "image",
                "image": {
                  "link": "https://cloudinary.com/product-image.jpg",
                  "caption": "Check out our new product!"
                }
              }
            }
          ]
        }
    """.trimIndent()

    val client = OkHttpClient()

    val requestBody = payload.toRequestBody("application/json".toMediaType())

    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()

    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

How to Get Public HTTPS Links

Upload your image to Cloudinary (free, easy), AWS S3, or your own server. Get the public HTTPS link and use it in the API request. No direct file upload needed. Prerequisites: Ensure the link is accessible without authentication.

Send Document

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "document",
        "document": {
          "link": "https://example.com/invoice.pdf ",
          "filename": "Invoice_12345.pdf"
        }
      }
    }
  ]
}

Preview

Customer

online

Invoice_12345.pdf

PDF

Type a message

Preview of message sent to Customer

Full code examples to send this document in multiple languages.

python

import requests
import os

token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message ')

payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "document",
        "document": {
          "link": "https://example.com/invoice.pdf ",
          "filename": "Invoice_12345.pdf"
        }
      }
    }
  ]
}

headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();

const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message ';

const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'document',
        document: {
          link: 'https://example.com/invoice.pdf ',
          filename: 'Invoice_12345.pdf'
        }
      }
    }
  ]
};

const sendDocument = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};

sendDocument();

php

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message ';

$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'document',
        'document' => [
          'link' => 'https://example.com/invoice.pdf ',
          'filename' => 'Invoice_12345.pdf'
        ]
      ]
    ]
  ]
];

$client = new Client();

try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;

public class SendDocument {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message ";

        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "document",
                    "document": {
                      "link": "https://example.com/invoice.pdf ",
                      "filename": "Invoice_12345.pdf"
                    }
                  }
                }
              ]
            }""";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message "
    }

    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "document",
            "document": {
              "link": "https://example.com/invoice.pdf ",
              "filename": "Invoice_12345.pdf"
            }
          }
        }
      ]
    }`)

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'

token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message '

payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'document',
        document: {
          link: 'https://example.com/invoice.pdf ',
          filename: 'Invoice_12345.pdf'
        }
      }
    }
  ]
}.to_json

uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload

begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message  \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "document",
        "document": {
          "link": "https://example.com/invoice.pdf ",
          "filename": "Invoice_12345.pdf"
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message ";

        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""document"",
                ""document"": {
                  ""link"": ""https://example.com/invoice.pdf "",
                  ""filename"": ""Invoice_12345.pdf""
                }
              }
            }
          ]
        }";

        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");

            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation

let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message "

guard let url = URL(string: urlString) else { return }

let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "document",
        "document": [
          "link": "https://example.com/invoice.pdf ",
          "filename": "Invoice_12345.pdf"
        ]
      ]
    ]
  ]
]

do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException

fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message "

    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "document",
                "document": {
                  "link": "https://example.com/invoice.pdf ",
                  "filename": "Invoice_12345.pdf"
                }
              }
            }
          ]
        }
    """.trimIndent()

    val client = OkHttpClient()

    val requestBody = payload.toRequestBody("application/json".toMediaType())

    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()

    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Send Audio

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "audio",
        "audio": {
          "link": "https://example.com/voice-message.mp3"
        }
      }
    }
  ]
}

Preview

Customer

online

0:15

Type a message

Preview of message sent to Customer

Full code examples to send this audio message in multiple languages.

python

import requests
import os

token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message')

payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "audio",
        "audio": {
          "link": "https://example.com/voice-message.mp3"
        }
      }
    }
  ]
}

headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();

const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message';

const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'audio',
        audio: {
          link: 'https://example.com/voice-message.mp3'
        }
      }
    }
  ]
};

const sendAudio = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};

sendAudio();

php

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message';

$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'audio',
        'audio' => [
          'link' => 'https://example.com/voice-message.mp3'
        ]
      ]
    ]
  ]
];

$client = new Client();

try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;

public class SendAudio {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message";

        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "audio",
                    "audio": {
                      "link": "https://example.com/voice-message.mp3"
                    }
                  }
                }
              ]
            }""";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message"
    }

    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "audio",
            "audio": {
              "link": "https://example.com/voice-message.mp3"
            }
          }
        }
      ]
    }`)

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'

token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message'

payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'audio',
        audio: {
          link: 'https://example.com/voice-message.mp3'
        }
      }
    }
  ]
}.to_json

uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload

begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "audio",
        "audio": {
          "link": "https://example.com/voice-message.mp3"
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message";

        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""audio"",
                ""audio"": {
                  ""link"": ""https://example.com/voice-message.mp3""
                }
              }
            }
          ]
        }";

        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");

            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation

let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message"

guard let url = URL(string: urlString) else { return }

let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "audio",
        "audio": [
          "link": "https://example.com/voice-message.mp3"
        ]
      ]
    ]
  ]
]

do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException

fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message"

    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "audio",
                "audio": {
                  "link": "https://example.com/voice-message.mp3"
                }
              }
            }
          ]
        }
    """.trimIndent()

    val client = OkHttpClient()

    val requestBody = payload.toRequestBody("application/json".toMediaType())

    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()

    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Send Location

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "location",
        "location": {
          "latitude": 23.0225,
          "longitude": 72.5714,
          "name": "Chat Mitra Office",
          "address": "Ahmedabad, Gujarat"
        }
      }
    }
  ]
}

Preview

Customer

online

Chat Mitra Office

Ahmedabad, Gujarat

Type a message

Preview of message sent to Customer

Full code examples to send this location in multiple languages.

python

import requests
import os

token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message ')

payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "location",
        "location": {
          "latitude": 23.0225,
          "longitude": 72.5714,
          "name": "Chat Mitra Office",
          "address": "Ahmedabad, Gujarat"
        }
      }
    }
  ]
}

headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}

try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();

const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message ';

const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'location',
        location: {
          latitude: 23.0225,
          longitude: 72.5714,
          name: 'Chat Mitra Office',
          address: 'Ahmedabad, Gujarat'
        }
      }
    }
  ]
};

const sendLocation = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};

sendLocation();

php

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message ';

$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'location',
        'location' => [
          'latitude' => 23.0225,
          'longitude' => 72.5714,
          'name' => 'Chat Mitra Office',
          'address' => 'Ahmedabad, Gujarat'
        ]
      ]
    ]
  ]
];

$client = new Client();

try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;

public class SendLocation {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message ";

        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "location",
                    "location": {
                      "latitude": 23.0225,
                      "longitude": 72.5714,
                      "name": "Chat Mitra Office",
                      "address": "Ahmedabad, Gujarat"
                    }
                  }
                }
              ]
            }""";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message "
    }

    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "location",
            "location": {
              "latitude": 23.0225,
              "longitude": 72.5714,
              "name": "Chat Mitra Office",
              "address": "Ahmedabad, Gujarat"
            }
          }
        }
      ]
    }`)

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }

    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'

token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message '

payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'location',
        location: {
          latitude: 23.0225,
          longitude: 72.5714,
          name: 'Chat Mitra Office',
          address: 'Ahmedabad, Gujarat'
        }
      }
    }
  ]
}.to_json

uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload

begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message  \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "location",
        "location": {
          "latitude": 23.0225,
          "longitude": 72.5714,
          "name": "Chat Mitra Office",
          "address": "Ahmedabad, Gujarat"
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message ";

        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""location"",
                ""location"": {
                  ""latitude"": 23.0225,
                  ""longitude"": 72.5714,
                  ""name"": ""Chat Mitra Office"",
                  ""address"": ""Ahmedabad, Gujarat""
                }
              }
            }
          ]
        }";

        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");

            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation

let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message "

guard let url = URL(string: urlString) else { return }

let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "location",
        "location": [
          "latitude": 23.0225,
          "longitude": 72.5714,
          "name": "Chat Mitra Office",
          "address": "Ahmedabad, Gujarat"
        ]
      ]
    ]
  ]
]

do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException

fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message "

    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "location",
                "location": {
                  "latitude": 23.0225,
                  "longitude": 72.5714,
                  "name": "Chat Mitra Office",
                  "address": "Ahmedabad, Gujarat"
                }
              }
            }
          ]
        }
    """.trimIndent()

    val client = OkHttpClient()

    val requestBody = payload.toRequestBody("application/json".toMediaType())

    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()

    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Location Message Use Cases

Send store locations, delivery addresses, event venues, office locations, or meeting spots. Customer can tap to open in Google Maps directly. Tip: Use accurate coords for best user experience.

Interactive Message - Buttons

Send clickable buttons for better user engagement and response collection. Why this matters: Increases interaction rates, like adding choices to a survey.

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "body": {
            "text": "Would you like to proceed with your order?"
          },
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "id": "btn_yes",
                  "title": "Yes, Proceed"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "btn_no",
                  "title": "Cancel Order"
                }
              }
            ]
          }
        }
      }
    }
  ]
}

Preview

Customer

online

Would you like to proceed with your order?

Yes, Proceed

Cancel Order

Type a message

Preview of message sent to Customer

Full code examples to send this interactive button message in multiple languages. All examples use the same payload, handle errors, and are ready to run.

python

import requests
import os
token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message')
payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "body": {
            "text": "Would you like to proceed with your order?"
          },
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "id": "btn_yes",
                  "title": "Yes, Proceed"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "btn_no",
                  "title": "Cancel Order"
                }
              }
            ]
          }
        }
      }
    }
  ]
}
headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}
try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();
const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message';
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'interactive',
        interactive: {
          type: 'button',
          body: {
            text: 'Would you like to proceed with your order?'
          },
          action: {
            buttons: [
              {
                type: 'reply',
                reply: {
                  id: 'btn_yes',
                  title: 'Yes, Proceed'
                }
              },
              {
                type: 'reply',
                reply: {
                  id: 'btn_no',
                  title: 'Cancel Order'
                }
              }
            ]
          }
        }
      }
    }
  ]
};
const sendButtonMessage = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};
sendButtonMessage();

php

<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;
$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();
$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message';
$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'interactive',
        'interactive' => [
          'type' => 'button',
          'body' => [
            'text' => 'Would you like to proceed with your order?'
          ],
          'action' => [
            'buttons' => [
              [
                'type' => 'reply',
                'reply' => [
                  'id' => 'btn_yes',
                  'title' => 'Yes, Proceed'
                ]
              ],
              [
                'type' => 'reply',
                'reply' => [
                  'id' => 'btn_no',
                  'title' => 'Cancel Order'
                ]
              ]
            ]
          ]
        ]
      ]
    ]
  ]
];
$client = new Client();
try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;
public class SendButtonMessage {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message";
        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "interactive",
                    "interactive": {
                      "type": "button",
                      "body": {
                        "text": "Would you like to proceed with your order?"
                      },
                      "action": {
                        "buttons": [
                          {
                            "type": "reply",
                            "reply": {
                              "id": "btn_yes",
                              "title": "Yes, Proceed"
                            }
                          },
                          {
                            "type": "reply",
                            "reply": {
                              "id": "btn_no",
                              "title": "Cancel Order"
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }""";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();
        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main
import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)
func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message"
    }
    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "interactive",
            "interactive": {
              "type": "button",
              "body": {
                "text": "Would you like to proceed with your order?"
              },
              "action": {
                "buttons": [
                  {
                    "type": "reply",
                    "reply": {
                      "id": "btn_yes",
                      "title": "Yes, Proceed"
                    }
                  },
                  {
                    "type": "reply",
                    "reply": {
                      "id": "btn_no",
                      "title": "Cancel Order"
                    }
                  }
                ]
              }
            }
          }
        }
      ]
    }`)
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }
    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'
token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message'
payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'interactive',
        interactive: {
          type: 'button',
          body: {
            text: 'Would you like to proceed with your order?'
          },
          action: {
            buttons: [
              {
                type: 'reply',
                reply: {
                  id: 'btn_yes',
                  title: 'Yes, Proceed'
                }
              },
              {
                type: 'reply',
                reply: {
                  id: 'btn_no',
                  title: 'Cancel Order'
                }
              }
            ]
          }
        }
      }
    }
  ]
}.to_json
uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "body": {
            "text": "Would you like to proceed with your order?"
          },
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "id": "btn_yes",
                  "title": "Yes, Proceed"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "btn_no",
                  "title": "Cancel Order"
                }
              }
            ]
          }
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message";
        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""interactive"",
                ""interactive"": {
                  ""type"": ""button"",
                  ""body"": {
                    ""text"": ""Would you like to proceed with your order?""
                  },
                  ""action"": {
                    ""buttons"": [
                      {
                        ""type"": ""reply"",
                        ""reply"": {
                          ""id"": ""btn_yes"",
                          ""title"": ""Yes, Proceed""
                        }
                      },
                      {
                        ""type"": ""reply"",
                        ""reply"": {
                          ""id"": ""btn_no"",
                          ""title"": ""Cancel Order""
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }";
        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");
            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation
let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message"
guard let url = URL(string: urlString) else { return }
let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "interactive",
        "interactive": [
          "type": "button",
          "body": [
            "text": "Would you like to proceed with your order?"
          ],
          "action": [
            "buttons": [
              [
                "type": "reply",
                "reply": [
                  "id": "btn_yes",
                  "title": "Yes, Proceed"
                ]
              ],
              [
                "type": "reply",
                "reply": [
                  "id": "btn_no",
                  "title": "Cancel Order"
                ]
              ]
            ]
          ]
        ]
      ]
    ]
  ]
]
do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
   
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
   
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException
fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message"
    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "interactive",
                "interactive": {
                  "type": "button",
                  "body": {
                    "text": "Would you like to proceed with your order?"
                  },
                  "action": {
                    "buttons": [
                      {
                        "type": "reply",
                        "reply": {
                          "id": "btn_yes",
                          "title": "Yes, Proceed"
                        }
                      },
                      {
                        "type": "reply",
                        "reply": {
                          "id": "btn_no",
                          "title": "Cancel Order"
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
    """.trimIndent()
    val client = OkHttpClient()
    val requestBody = payload.toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()
    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Interactive Message - Dropdown List

Send dropdown lists for options selection (product categories, support topics, etc). Break down: First, define sections, then rows with IDs for responses.

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "list",
          "body": {
            "text": "Select a category:"
          },
          "action": {
            "button": "Browse",
            "sections": [
              {
                "title": "Support",
                "rows": [
                  {
                    "id": "tech_support",
                    "title": "Technical Issue",
                    "description": "Report a bug or technical problem"
                  },
                  {
                    "id": "billing",
                    "title": "Billing Question",
                    "description": "Questions about charges or subscription"
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}

Preview

Customer

online

Select a category:

Browse

Type a message

Preview of message sent to Customer

Full code examples to send this dropdown list message in multiple languages. All examples use the same payload, handle errors, and are ready to run.

python

import requests
import os
token = os.getenv('CHATMITRA_API_TOKEN')
url = os.getenv('CHATMITRA_API_URL', 'https://backend.chatmitra.com/developer/api/send_message')
payload = {
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "list",
          "body": {
            "text": "Select a category:"
          },
          "action": {
            "button": "Browse",
            "sections": [
              {
                "title": "Support",
                "rows": [
                  {
                    "id": "tech_support",
                    "title": "Technical Issue",
                    "description": "Report a bug or technical problem"
                  },
                  {
                    "id": "billing",
                    "title": "Billing Question",
                    "description": "Questions about charges or subscription"
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}
headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json'
}
try:
    response = requests.post(url, json=payload, headers=headers)
    response.raise_for_status()
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

node.js

const axios = require('axios');
require('dotenv').config();
const token = process.env.CHATMITRA_API_TOKEN;
const url = process.env.CHATMITRA_API_URL || 'https://backend.chatmitra.com/developer/api/send_message';
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'interactive',
        interactive: {
          type: 'list',
          body: {
            text: 'Select a category:'
          },
          action: {
            button: 'Browse',
            sections: [
              {
                title: 'Support',
                rows: [
                  {
                    id: 'tech_support',
                    title: 'Technical Issue',
                    description: 'Report a bug or technical problem'
                  },
                  {
                    id: 'billing',
                    title: 'Billing Question',
                    description: 'Questions about charges or subscription'
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
};
const sendListMessage = async () => {
  try {
    const response = await axios.post(url, payload, {
      headers: {
        Authorization: `Bearer ${token}`,
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error:', error.response ? error.response.data : error.message);
  }
};
sendListMessage();

php

<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Dotenv\Dotenv;
$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();
$token = $_ENV['CHATMITRA_API_TOKEN'];
$url = $_ENV['CHATMITRA_API_URL'] ?? 'https://backend.chatmitra.com/developer/api/send_message';
$payload = [
  'recipient_mobile_number' => '919999999999',
  'messages' => [
    [
      'kind' => 'raw',
      'payload' => [
        'type' => 'interactive',
        'interactive' => [
          'type' => 'list',
          'body' => [
            'text' => 'Select a category:'
          ],
          'action' => [
            'button' => 'Browse',
            'sections' => [
              [
                'title' => 'Support',
                'rows' => [
                  [
                    'id' => 'tech_support',
                    'title' => 'Technical Issue',
                    'description' => 'Report a bug or technical problem'
                  ],
                  [
                    'id' => 'billing',
                    'title' => 'Billing Question',
                    'description' => 'Questions about charges or subscription'
                  ]
                ]
              ]
            ]
          ]
        ]
      ]
    ]
  ]
];
$client = new Client();
try {
    $response = $client->post($url, [
        'headers' => [
            'Authorization' => "Bearer $token",
            'Content-Type' => 'application/json'
        ],
        'json' => $payload
    ]);
    echo $response->getBody()->getContents();
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        echo "Error: " . $e->getResponse()->getBody()->getContents();
    } else {
        echo "Error: " . $e->getMessage();
    }
} ?>

java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.io.IOException;
public class SendListMessage {
    public static void main(String[] args) throws IOException, InterruptedException {
        String token = System.getenv("CHATMITRA_API_TOKEN");
        String url = System.getenv("CHATMITRA_API_URL") != null ? System.getenv("CHATMITRA_API_URL") : "https://backend.chatmitra.com/developer/api/send_message";
        String payload = """
            {
              "recipient_mobile_number": "919999999999",
              "messages": [
                {
                  "kind": "raw",
                  "payload": {
                    "type": "interactive",
                    "interactive": {
                      "type": "list",
                      "body": {
                        "text": "Select a category:"
                      },
                      "action": {
                        "button": "Browse",
                        "sections": [
                          {
                            "title": "Support",
                            "rows": [
                              {
                                "id": "tech_support",
                                "title": "Technical Issue",
                                "description": "Report a bug or technical problem"
                              },
                              {
                                "id": "billing",
                                "title": "Billing Question",
                                "description": "Questions about charges or subscription"
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }""";
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer " + token)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();
        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            System.err.println("Error: " + e.getMessage());
            throw e;
        }
    }
}

package main
import (
    "bytes"
    "fmt"
    "io"
    "net/http"
    "os"
)
func main() {
    token := os.Getenv("CHATMITRA_API_TOKEN")
    url := os.Getenv("CHATMITRA_API_URL")
    if url == "" {
        url = "https://backend.chatmitra.com/developer/api/send_message"
    }
    payload := []byte(`{
      "recipient_mobile_number": "919999999999",
      "messages": [
        {
          "kind": "raw",
          "payload": {
            "type": "interactive",
            "interactive": {
              "type": "list",
              "body": {
                "text": "Select a category:"
              },
              "action": {
                "button": "Browse",
                "sections": [
                  {
                    "title": "Support",
                    "rows": [
                      {
                        "id": "tech_support",
                        "title": "Technical Issue",
                        "description": "Report a bug or technical problem"
                      },
                      {
                        "id": "billing",
                        "title": "Billing Question",
                        "description": "Questions about charges or subscription"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      ]
    }`)
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("Authorization", "Bearer " + token)
    req.Header.Set("Content-Type", "application/json")
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error sending request:", err)
        return
    }
    defer resp.Body.Close()
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }
    fmt.Println(string(body))
}

ruby

require 'net/http'
require 'uri'
require 'json'
require 'dotenv/load'
token = ENV['CHATMITRA_API_TOKEN']
url = ENV['CHATMITRA_API_URL'] || 'https://backend.chatmitra.com/developer/api/send_message'
payload = {
  recipient_mobile_number: '919999999999',
  messages: [
    {
      kind: 'raw',
      payload: {
        type: 'interactive',
        interactive: {
          type: 'list',
          body: {
            text: 'Select a category:'
          },
          action: {
            button: 'Browse',
            sections: [
              {
                title: 'Support',
                rows: [
                  {
                    id: 'tech_support',
                    title: 'Technical Issue',
                    description: 'Report a bug or technical problem'
                  },
                  {
                    id: 'billing',
                    title: 'Billing Question',
                    description: 'Questions about charges or subscription'
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}.to_json
uri = URI.parse(url)
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{token}"
request['Content-Type'] = 'application/json'
request.body = payload
begin
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
    http.request(request)
  end
  puts response.body
rescue StandardError => e
  puts "Error: #{e.message}"
end

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer $CHATMITRA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "raw",
      "payload": {
        "type": "interactive",
        "interactive": {
          "type": "list",
          "body": {
            "text": "Select a category:"
          },
          "action": {
            "button": "Browse",
            "sections": [
              {
                "title": "Support",
                "rows": [
                  {
                    "id": "tech_support",
                    "title": "Technical Issue",
                    "description": "Report a bug or technical problem"
                  },
                  {
                    "id": "billing",
                    "title": "Billing Question",
                    "description": "Questions about charges or subscription"
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}'

c# (.net)

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
class Program {
    static async Task Main(string[] args) {
        string token = Environment.GetEnvironmentVariable("CHATMITRA_API_TOKEN");
        string url = Environment.GetEnvironmentVariable("CHATMITRA_API_URL") ?? "https://backend.chatmitra.com/developer/api/send_message";
        string payload = @"
        {
          ""recipient_mobile_number"": ""919999999999"",
          ""messages"": [
            {
              ""kind"": ""raw"",
              ""payload"": {
                ""type"": ""interactive"",
                ""interactive"": {
                  ""type"": ""list"",
                  ""body"": {
                    ""text"": ""Select a category:""
                  },
                  ""action"": {
                    ""button"": ""Browse"",
                    ""sections"": [
                      {
                        ""title"": ""Support"",
                        ""rows"": [
                          {
                            ""id"": ""tech_support"",
                            ""title"": ""Technical Issue"",
                            ""description"": ""Report a bug or technical problem""
                          },
                          {
                            ""id"": ""billing"",
                            ""title"": ""Billing Question"",
                            ""description"": ""Questions about charges or subscription""
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          ]
        }";
        using (HttpClient client = new HttpClient()) {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {token}");
            client.DefaultRequestHeaders.Add("ContentType", "application/json");
            try {
                HttpContent content = new StringContent(payload, Encoding.UTF8, "application/json");
                HttpResponseMessage response = await client.PostAsync(url, content);
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            } catch (HttpRequestException e) {
                Console.WriteLine("Error: " + e.Message);
            }
        }
    }
}

swift (ios)

import Foundation
let token = ProcessInfo.processInfo.environment["CHATMITRA_API_TOKEN"] ?? ""
var urlString = ProcessInfo.processInfo.environment["CHATMITRA_API_URL"] ?? "https://backend.chatmitra.com/developer/api/send_message"
guard let url = URL(string: urlString) else { return }
let payload: [String: Any] = [
  "recipient_mobile_number": "919999999999",
  "messages": [
    [
      "kind": "raw",
      "payload": [
        "type": "interactive",
        "interactive": [
          "type": "list",
          "body": [
            "text": "Select a category:"
          ],
          "action": [
            "button": "Browse",
            "sections": [
              [
                "title": "Support",
                "rows": [
                  [
                    "id": "tech_support",
                    "title": "Technical Issue",
                    "description": "Report a bug or technical problem"
                  ],
                  [
                    "id": "billing",
                    "title": "Billing Question",
                    "description": "Questions about charges or subscription"
                  ]
                ]
              ]
            ]
          ]
        ]
      ]
    ]
  ]
]
do {
    let jsonData = try JSONSerialization.data(withJSONObject: payload)
   
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = jsonData
   
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Error: \(error.localizedDescription)")
            return
        }
        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print(responseString)
        }
    }
    task.resume()
} catch {
    print("Error: \(error.localizedDescription)")
}

kotlin (android)

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.io.IOException
fun main() {
    val token = System.getenv("CHATMITRA_API_TOKEN") ?: ""
    val url = System.getenv("CHATMITRA_API_URL") ?: "https://backend.chatmitra.com/developer/api/send_message"
    val payload = """
        {
          "recipient_mobile_number": "919999999999",
          "messages": [
            {
              "kind": "raw",
              "payload": {
                "type": "interactive",
                "interactive": {
                  "type": "list",
                  "body": {
                    "text": "Select a category:"
                  },
                  "action": {
                    "button": "Browse",
                    "sections": [
                      {
                        "title": "Support",
                        "rows": [
                          {
                            "id": "tech_support",
                            "title": "Technical Issue",
                            "description": "Report a bug or technical problem"
                          },
                          {
                            "id": "billing",
                            "title": "Billing Question",
                            "description": "Questions about charges or subscription"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
    """.trimIndent()
    val client = OkHttpClient()
    val requestBody = payload.toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url(url)
        .post(requestBody)
        .addHeader("Authorization", "Bearer $token")
        .addHeader("Content-Type", "application/json")
        .build()
    try {
        client.newCall(request).execute().use { response ->
            if (!response.isSuccessful) throw IOException("Unexpected code $response")
            println(response.body!!.string())
        }
    } catch (e: IOException) {
        println(e.message)
    }
}

Sending Media & Files

Send images, videos, documents, and audio files via WhatsApp. All files must be hosted on public HTTPS URLs. Recommended: Use cloud storage services like Cloudinary, AWS S3, or your own server. Use permanent URLs as WhatsApp caches media for 30 days. Why this matters: Ensures media loads reliably without breaking links.

Supported File Types & Size Limits

Media Type	Formats	Max Size	Best Practices
Image	JPG, PNG, WEBP	5 MB	1-2 MB for fast loading
Video	MP4, 3GP	16 MB	H.264 codec, 5-16 MB
Audio	MP3, OGG, OPUS	16 MB	128 kbps bitrate
Document	PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT	100 MB	PDF preferred
Sticker	WEBP (static/animated)	500 KB	Square format, 512x512 pixels, transparent background recommended

HTTPS Required for All Media URLs

Localhost URLs and private IP addresses (192.168.*, 10.*, 127.*) are blocked for security. Always use public HTTPS URLs. Size limits ensure fast delivery; exceeding them causes failures. See Errors tab for fixes.

24-Hour Window & Media Messages

Media messages follow the same 24-hour window rules as text messages. If you need to send media outside the 24-hour window, you must use Media Template Messages (pre-approved templates with media headers) instead of raw media messages.

WhatsApp Business API Template Messages

Pre-approved message templates for marketing campaigns, utility notifications, and authentication. Optimize customer engagement with Meta's official WhatsApp Business Platform.

POST /send_message

Send pre-approved template messages. Templates support dynamic parameters, media headers, and interactive buttons. All templates require Meta approval before use.

Template Must Be Approved First

Templates require Meta approval (usually 24-48 hours). Create and manage templates in your Chatmitra Dashboard → Templates section. Rejected templates must be revised and resubmitted.

Promotional Broadcasts

Send mass promotional campaigns with rich media and dynamic discounts.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Campaign Name
• <code>{{3}}</code> = Discount Offer
• <code>{{4}}</code> = Expiry Date

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "promotional_broadcast_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "https://example.com/sale-banner.jpg"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "John"
              },
              {
                "type": "text",
                "text": "Summer Sale"
              },
              {
                "type": "text",
                "text": "50% OFF"
              },
              {
                "type": "text",
                "text": "June 30, 2024"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "summer-sale-2024"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "promotional_broadcast_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "image", "image": {"link": "https://example.com/sale-banner.jpg"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "John"},
                        {"type": "text", "text": "Summer Sale"},
                        {"type": "text", "text": "50% OFF"},
                        {"type": "text", "text": "June 30, 2024"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'promotional_broadcast_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'image', image: {link: 'https://example.com/sale-banner.jpg'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'John'},
          {type: 'text', text: 'Summer Sale'},
          {type: 'text', text: '50% OFF'},
          {type: 'text', text: 'June 30, 2024'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "promotional_broadcast_v1",
        "language": "en",
        "components": [
          {"type": "header", "parameters": [{"type": "image", "image": {"link": "https://example.com/sale-banner.jpg"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "John"}, {"type": "text", "text": "Summer Sale"}]}
        ]
      }
    }]
  }'

Best Practices

Use high-quality images (1200x628px), keep text under 150 characters, and include clear CTAs.

Preview

Customer

online

Image Header

Hi {{1}}, don't miss our {{2}}! Get {{3}} on all items until {{4}}.

Shop now while stocks last!

Type a message

Preview of message sent to Customer

Seasonal Campaigns

Festival and holiday themed promotional campaigns.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Festival/Event Name
• <code>{{3}}</code> = Discount Offer
• <code>{{4}}</code> = Valid Until Date

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "seasonal_campaign_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "https://example.com/holi-sale.jpg"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Priya"
              },
              {
                "type": "text",
                "text": "Holi Special"
              },
              {
                "type": "text",
                "text": "40% OFF"
              },
              {
                "type": "text",
                "text": "March 25, 2024"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "holi-colors-2024"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "seasonal_campaign_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "image", "image": {"link": "https://example.com/holi-sale.jpg"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Priya"},
                        {"type": "text", "text": "Holi Special"},
                        {"type": "text", "text": "40% OFF"},
                        {"type": "text", "text": "March 25, 2024"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'seasonal_campaign_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'image', image: {link: 'https://example.com/holi-sale.jpg'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Priya'},
          {type: 'text', text: 'Holi Special'},
          {type: 'text', text: '40% OFF'},
          {type: 'text', text: 'March 25, 2024'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "seasonal_campaign_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "image", "image": {"link": "https://example.com/holi-sale.jpg"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Priya"}, {"type": "text", "text": "Holi Special"}]}
        ]
      }
    }]
  }'

Festival Marketing

Time-sensitive campaigns for Diwali, Holi, Christmas, New Year, etc.

Preview

Customer

online

Image Header

Hi {{1}}, celebrate with our {{2}}! Get {{3}} on all colorful collections until {{4}}.

Limited stock available!

Type a message

Preview of message sent to Customer

Product Launch

Announce new products with video teasers and pre-booking options.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Product Name
• <code>{{3}}</code> = Starting Price
• <code>{{4}}</code> = Call to Action

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "product_launch_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "video",
                "video": {
                  "link": "https://example.com/launch-video.mp4"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rahul"
              },
              {
                "type": "text",
                "text": "iPhone 15 Pro"
              },
              {
                "type": "text",
                "text": "₹1,29,900"
              },
              {
                "type": "text",
                "text": "Pre-book now"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "iphone-15-pro"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "product_launch_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "video", "video": {"link": "https://example.com/launch-video.mp4"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rahul"},
                        {"type": "text", "text": "iPhone 15 Pro"},
                        {"type": "text", "text": "₹1,29,900"},
                        {"type": "text", "text": "Pre-book now"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'product_launch_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'video', video: {link: 'https://example.com/launch-video.mp4'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rahul'},
          {type: 'text', text: 'iPhone 15 Pro'},
          {type: 'text', text: '₹1,29,900'},
          {type: 'text', text: 'Pre-book now'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "product_launch_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "video", "video": {"link": "https://example.com/launch-video.mp4"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Rahul"}, {"type": "text", "text": "iPhone 15 Pro"}]}
        ]
      }
    }]
  }'

Launch Strategy

Use video headers for maximum impact. Include exclusive early-bird offers.

Preview

Customer

online

Hi {{1}}, introducing the all-new {{2}}! Starting at {{3}}. {{4}} to get exclusive launch benefits.

Limited launch edition available

Type a message

Preview of message sent to Customer

Discounts & Offers

Limited-time discount codes with easy copy functionality.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Coupon Code
• <code>{{3}}</code> = Discount Percentage
• <code>{{4}}</code> = Expiry Time

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "discount_offer_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🔥 Flat 50% OFF 🔥"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Amit"
              },
              {
                "type": "text",
                "text": "ENDOFSEASON50"
              },
              {
                "type": "text",
                "text": "50%"
              },
              {
                "type": "text",
                "text": "2 hours"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "ENDOFSEASON50"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "discount_offer_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🔥 Flat 50% OFF 🔥"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Amit"},
                        {"type": "text", "text": "ENDOFSEASON50"},
                        {"type": "text", "text": "50%"},
                        {"type": "text", "text": "2 hours"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "ENDOFSEASON50"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'discount_offer_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🔥 Flat 50% OFF 🔥'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Amit'},
          {type: 'text', text: 'ENDOFSEASON50'},
          {type: 'text', text: '50%'},
          {type: 'text', text: '2 hours'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: 'ENDOFSEASON50'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "discount_offer_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🔥 Flat 50% OFF 🔥"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Amit"}, {"type": "text", "text": "ENDOFSEASON50"}]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "ENDOFSEASON50"}]}
        ]
      }
    }]
  }'

Urgency Marketing

Use countdown timers and limited-time offers to drive immediate action.

Preview

Customer

online

🔥 Flat {{3}} OFF 🔥

Hi {{1}}, use code {{2}} to get {{3}} off your next purchase! Offer expires in {{4}}.

Tap below to copy code

Type a message

Preview of message sent to Customer

Abandoned Cart

Recover lost sales with cart reminders and incentives.

Parameters

• {{1}} = Customer Name
• {{2}} = Item Count
• {{3}} = Cart Total (Currency)
• {{4}} = Incentive Offer

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "abandoned_cart_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "https://example.com/cart-items.jpg"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Sarah"
              },
              {
                "type": "text",
                "text": "3"
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 459900
                }
              },
              {
                "type": "text",
                "text": "10% OFF"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "complete-order-123"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "abandoned_cart_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "image", "image": {"link": "https://example.com/cart-items.jpg"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Sarah"},
                        {"type": "text", "text": "3"},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 459900}},
                        {"type": "text", "text": "10% OFF"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'abandoned_cart_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'image', image: {link: 'https://example.com/cart-items.jpg'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Sarah'},
          {type: 'text', text: '3'},
          {type: 'currency', currency: {code: 'INR', amount_1000: 459900}},
          {type: 'text', text: '10% OFF'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "abandoned_cart_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "image", "image": {"link": "https://example.com/cart-items.jpg"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Sarah"}, {"type": "currency", "currency": {"code": "INR", "amount_1000": 459900}}]}
        ]
      }
    }]
  }'

Recovery Strategy

Send within 1-3 hours of abandonment. Include product images for better recall.

Preview

Customer

online

Image Header

Hi {{1}}, you left {{2}} items in your cart worth {{3}}. Complete your order now and get {{4}}!

Your cart expires in 24 hours

Type a message

Preview of message sent to Customer

Cross-sell & Upsell

Recommend complementary products based on purchase history.

Parameters

• {{1}} = Customer Name
• {{2}} = Purchased Item
• {{3}} = Recommended Item
• {{4}} = Bundle Discount

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "cross_sell_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "Complete Your Look"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram"
              },
              {
                "type": "text",
                "text": "Running Shoes"
              },
              {
                "type": "text",
                "text": "Sports Socks"
              },
              {
                "type": "text",
                "text": "20% OFF"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "complete-look-123"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message "
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "cross_sell_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "Complete Your Look"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram"},
                        {"type": "text", "text": "Running Shoes"},
                        {"type": "text", "text": "Sports Socks"},
                        {"type": "text", "text": "20% OFF"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'cross_sell_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: 'Complete Your Look'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram'},
          {type: 'text', text: 'Running Shoes'},
          {type: 'text', text: 'Sports Socks'},
          {type: 'text', text: '20% OFF'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message ', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message  \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "cross_sell_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "Complete Your Look"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Vikram"}, {"type": "text", "text": "Running Shoes"}]}
        ]
      }
    }]
  }'

Smart Recommendations

Send 24-48 hours after purchase. Use purchase history for personalization.

Preview

Customer

online

Complete Your Look

Hi {{1}}, you bought {{2}}. Customers also loved {{3}}. Get {{4}} when you buy them together!

Limited time bundle offer

Type a message

Preview of message sent to Customer

Loyalty Programs

Update customers on reward points and tier status.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Points Balance
• <code>{{3}}</code> = Points Value
• <code>{{4}}</code> = Membership Tier

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "loyalty_update_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🏆 Gold Member"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Neha"
              },
              {
                "type": "text",
                "text": "2,450"
              },
              {
                "type": "text",
                "text": "₹500"
              },
              {
                "type": "text",
                "text": "Gold"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "redeem-points"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "loyalty_update_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🏆 Gold Member"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Neha"},
                        {"type": "text", "text": "2,450"},
                        {"type": "text", "text": "₹500"},
                        {"type": "text", "text": "Gold"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'loyalty_update_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🏆 Gold Member'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Neha'},
          {type: 'text', text: '2,450'},
          {type: 'text', text: '₹500'},
          {type: 'text', text: 'Gold'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "loyalty_update_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🏆 Gold Member"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Neha"}, {"type": "text", "text": "2,450"}]}
        ]
      }
    }]
  }'

Retention Strategy

Monthly points updates increase repeat purchase rates by 40%.

Preview

Customer

online

🏆 {{4}} Member

Hi {{1}}, you have {{2}} points worth {{3}}. Redeem now for exclusive rewards!

Points expire on Dec 31, 2024

Type a message

Preview of message sent to Customer

Event Invitations

Webinars, sales events, and exclusive previews.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Event Name
• <code>{{3}}</code> = Event Date
• <code>{{4}}</code> = Event Time

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "event_invite_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "https://example.com/webinar-banner.jpg"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Arjun"
              },
              {
                "type": "text",
                "text": "Digital Marketing Masterclass"
              },
              {
                "type": "text",
                "text": "March 15, 2024"
              },
              {
                "type": "text",
                "text": "2:00 PM IST"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "register-webinar-123"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "event_invite_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "image", "image": {"link": "https://example.com/webinar-banner.jpg"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Arjun"},
                        {"type": "text", "text": "Digital Marketing Masterclass"},
                        {"type": "text", "text": "March 15, 2024"},
                        {"type": "text", "text": "2:00 PM IST"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'event_invite_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'image', image: {link: 'https://example.com/webinar-banner.jpg'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Arjun'},
          {type: 'text', text: 'Digital Marketing Masterclass'},
          {type: 'text', text: 'March 15, 2024'},
          {type: 'text', text: '2:00 PM IST'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "event_invite_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "image", "image": {"link": "https://example.com/webinar-banner.jpg"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Arjun"}, {"type": "text", "text": "Digital Marketing Masterclass"}]}
        ]
      }
    }]
  }'

Event Marketing

Send 1 week before event with reminder 24 hours prior.

Preview

Customer

online

Image Header

Hi {{1}}, you're invited to {{2}} on {{3}} at {{4}}. Reserve your spot now!

Limited seats available

Type a message

Preview of message sent to Customer

Weekly or monthly updates with curated content.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Number of Updates
• <code>{{3}}</code> = Featured Update
• <code>{{4}}</code> = Special Offer

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "weekly_newsletter_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "📰 Weekly Digest"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Priya"
              },
              {
                "type": "text",
                "text": "5"
              },
              {
                "type": "text",
                "text": "New Summer Collection"
              },
              {
                "type": "text",
                "text": "30% OFF"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "newsletter-week-12"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "weekly_newsletter_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "📰 Weekly Digest"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Priya"},
                        {"type": "text", "text": "5"},
                        {"type": "text", "text": "New Summer Collection"},
                        {"type": "text", "text": "30% OFF"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'weekly_newsletter_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '📰 Weekly Digest'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Priya'},
          {type: 'text', text: '5'},
          {type: 'text', text: 'New Summer Collection'},
          {type: 'text', text: '30% OFF'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "weekly_newsletter_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "📰 Weekly Digest"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Priya"}, {"type": "text", "text": "5"}]}
        ]
      }
    }]
  }'

Content Strategy

Keep it concise. WhatsApp newsletters perform best with 3-5 bite-sized updates.

Preview

Customer

online

📰 Weekly Digest

Hi {{1}}, here are {{2}} updates this week: {{3}} now live, plus {{4}} on selected items!

Unsubscribe anytime

Type a message

Preview of message sent to Customer

Re-engagement

Win back inactive customers with special incentives.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Inactive Duration
• <code>{{3}}</code> = Discount Offer
• <code>{{4}}</code> = Coupon Code

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "win_back_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "We Miss You! 💔"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rohan"
              },
              {
                "type": "text",
                "text": "3 months"
              },
              {
                "type": "text",
                "text": "25% OFF"
              },
              {
                "type": "text",
                "text": "COMEBACK25"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "COMEBACK25"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "win_back_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "We Miss You! 💔"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rohan"},
                        {"type": "text", "text": "3 months"},
                        {"type": "text", "text": "25% OFF"},
                        {"type": "text", "text": "COMEBACK25"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "COMEBACK25"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'win_back_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: 'We Miss You! 💔'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rohan'},
          {type: 'text', text: '3 months'},
          {type: 'text', text: '25% OFF'},
          {type: 'text', text: 'COMEBACK25'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: 'COMEBACK25'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "win_back_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "We Miss You! 💔"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Rohan"}, {"type": "text", "text": "3 months"}]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "COMEBACK25"}]}
        ]
      }
    }]
  }'

Win-Back Strategy

Target customers inactive for 30+ days. Higher discounts (20-30%) work best.

Preview

Customer

online

We Miss You! 💔

Hi {{1}}, it's been {{2}} since your last visit. Here's {{3}} off your next order with code {{4}}.

Valid for 7 days only

Type a message

Preview of message sent to Customer

Flash Sales

Urgent limited-time offers to drive immediate action.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Urgency (Time)
• <code>{{3}}</code> = Discount
• <code>{{4}}</code> = Category

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "flash_sale_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "⚡ FLASH SALE ⚡"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Ananya"
              },
              {
                "type": "text",
                "text": "2 Hours Only"
              },
              {
                "type": "text",
                "text": "60% OFF"
              },
              {
                "type": "text",
                "text": "Premium Electronics"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "flash-deal-123"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "flash_sale_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "⚡ FLASH SALE ⚡"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Ananya"},
                        {"type": "text", "text": "2 Hours Only"},
                        {"type": "text", "text": "60% OFF"},
                        {"type": "text", "text": "Premium Electronics"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'flash_sale_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '⚡ FLASH SALE ⚡'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Ananya'},
          {type: 'text', text: '2 Hours Only'},
          {type: 'text', text: '60% OFF'},
          {type: 'text', text: 'Premium Electronics'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "flash_sale_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "⚡ FLASH SALE ⚡"}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Ananya"}, {"type": "text", "text": "2 Hours Only"}]}
        ]
      }
    }]
  }'

Urgency Tactics

Use countdown timers and words like "Only", "Last Chance", "Ending Soon".

Preview

Customer

online

⚡ FLASH SALE ⚡

Hi {{1}}, {{2}}! Get {{3}} on {{4}}. Hurry, ends at midnight!

While stocks last

Type a message

Preview of message sent to Customer

New Arrivals

Showcase latest collections and new stock updates.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Collection Name
• <code>{{3}}</code> = Item Count
• <code>{{4}}</code> = Launch Offer

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "new_arrivals_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "https://example.com/new-collection.jpg"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Karan"
              },
              {
                "type": "text",
                "text": "Summer Collection 2024"
              },
              {
                "type": "text",
                "text": "50+"
              },
              {
                "type": "text",
                "text": "Early Bird 15% OFF"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "new-summer-24"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "new_arrivals_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "image", "image": {"link": "https://example.com/new-collection.jpg"}}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Karan"},
                        {"type": "text", "text": "Summer Collection 2024"},
                        {"type": "text", "text": "50+"},
                        {"type": "text", "text": "Early Bird 15% OFF"}
                    ]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'new_arrivals_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'image', image: {link: 'https://example.com/new-collection.jpg'}}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Karan'},
          {type: 'text', text: 'Summer Collection 2024'},
          {type: 'text', text: '50+'},
          {type: 'text', text: 'Early Bird 15% OFF'}
        ]}
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "new_arrivals_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "image", "image": {"link": "https://example.com/new-collection.jpg"}}]},
          {"type": "body", "parameters": [{"type": "text", "text": "Karan"}, {"type": "text", "text": "Summer Collection 2024"}]}
        ]
      }
    }]
  }'

Launch Strategy

Send to VIP customers 24 hours before public launch for exclusivity.

Preview

Customer

online

Image Header

Hi {{1}}, discover our {{2}} with {{3}} new styles. {{4}} for first 100 customers!

Be the first to shop

Type a message

Preview of message sent to Customer

Order Confirmations

Send comprehensive order confirmation details immediately after purchase. Includes product details, pricing, delivery estimates, and tracking capabilities. Essential for e-commerce platforms like Shopify, WooCommerce, and Magento to reduce buyer anxiety and provide immediate purchase documentation.

Template Parameters

• <code>{{1}}</code> = Customer Full Name
• <code>{{2}}</code> = Product Name (with variant)
• <code>{{3}}</code> = Color/Size Specification
• <code>{{4}}</code> = Total Amount (Currency format)
• <code>{{5}}</code> = Delivery Timeframe
• <code>{{6}}</code> = Delivery Location/City

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "order_confirmation_v2",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "✅ Order #ORD-2024-78432 Confirmed"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram Sharma"
              },
              {
                "type": "text",
                "text": "Wireless Bluetooth Headphones Pro X5"
              },
              {
                "type": "text",
                "text": "Midnight Black"
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 249900
                }
              },
              {
                "type": "text",
                "text": "3-5 business days"
              },
              {
                "type": "text",
                "text": "Mumbai, Maharashtra"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "track-ORD-2024-78432"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "order_confirmation_v2",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "✅ Order #ORD-2024-78432 Confirmed"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram Sharma"},
                        {"type": "text", "text": "Wireless Bluetooth Headphones Pro X5"},
                        {"type": "text", "text": "Midnight Black"},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 249900}},
                        {"type": "text", "text": "3-5 business days"},
                        {"type": "text", "text": "Mumbai, Maharashtra"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "track-ORD-2024-78432"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'order_confirmation_v2',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '✅ Order #ORD-2024-78432 Confirmed'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram Sharma'},
          {type: 'text', text: 'Wireless Bluetooth Headphones Pro X5'},
          {type: 'text', text: 'Midnight Black'},
          {type: 'currency', currency: {code: 'INR', amount_1000: 249900}},
          {type: 'text', text: '3-5 business days'},
          {type: 'text', text: 'Mumbai, Maharashtra'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'track-ORD-2024-78432'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "order_confirmation_v2",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "✅ Order #ORD-2024-78432 Confirmed"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Vikram Sharma"},
            {"type": "currency", "currency": {"code": "INR", "amount_1000": 249900}}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "track-ORD-2024-78432"}]}
        ]
      }
    }]
  }'

E-commerce Best Practice

Send within 2 minutes of order placement. Include order ID in header for easy reference. For Shopify/WooCommerce, trigger via webhook on order creation event.

WhatsApp Preview

Customer

online

✅ Order {{1}} Confirmed

Hi {{1}}, thank you for shopping with us! Your order for {{2}} (Color: {{3}}) has been successfully placed. Order Total: {{4}}. Estimated delivery to {{6}}: {{5}}. We'll send you tracking details once your order ships.

Questions? Reply to chat with our support team

Type a message

Preview of message sent to Customer

Shipping Updates

Notify customers when their order ships with complete logistics details. Includes courier name, tracking number, expected delivery date, and origin/destination information. Critical for e-commerce customer experience and reducing "where is my order" support tickets.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Courier Partner (Blue Dart/Delhivery)
• <code>{{3}}</code> = Tracking Number
• <code>{{4}}</code> = Expected Delivery Date
• <code>{{5}}</code> = Origin Warehouse
• <code>{{6}}</code> = Destination City/Pincode

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "shipping_update_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🚚 Order #ORD-2024-78432 Shipped"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram Sharma"
              },
              {
                "type": "text",
                "text": "Blue Dart Express"
              },
              {
                "type": "text",
                "text": "BD-9988776655"
              },
              {
                "type": "text",
                "text": "January 28, 2024"
              },
              {
                "type": "text",
                "text": "Mumbai Warehouse"
              },
              {
                "type": "text",
                "text": "Delhi, 110001"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "track-BD-9988776655"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "shipping_update_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🚚 Order #ORD-2024-78432 Shipped"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram Sharma"},
                        {"type": "text", "text": "Blue Dart Express"},
                        {"type": "text", "text": "BD-9988776655"},
                        {"type": "text", "text": "January 28, 2024"},
                        {"type": "text", "text": "Mumbai Warehouse"},
                        {"type": "text", "text": "Delhi, 110001"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "track-BD-9988776655"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'shipping_update_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🚚 Order #ORD-2024-78432 Shipped'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram Sharma'},
          {type: 'text', text: 'Blue Dart Express'},
          {type: 'text', text: 'BD-9988776655'},
          {type: 'text', text: 'January 28, 2024'},
          {type: 'text', text: 'Mumbai Warehouse'},
          {type: 'text', text: 'Delhi, 110001'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'track-BD-9988776655'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "shipping_update_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🚚 Order #ORD-2024-78432 Shipped"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Vikram Sharma"},
            {"type": "text", "text": "Blue Dart Express"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "track-BD-9988776655"}]}
        ]
      }
    }]
  }'

Logistics Integration

Trigger when courier API confirms pickup. Works with Shiprocket, Delhivery, and Blue Dart APIs.

Preview

Customer

online

🚚 Order {{1}} Shipped

Hi {{1}}, great news! Your order has been shipped via {{2}}. Tracking Number: {{3}}. Expected delivery by {{4}}. Your package is currently at {{5}} and heading to {{6}}. Track real-time updates below.

You can also track at bluedart.com

Type a message

Preview of message sent to Customer

Delivery Notifications

Real-time alerts when package is out for delivery with delivery partner details and time slots. Essential for high-value e-commerce deliveries to ensure customer availability and reduce failed delivery attempts.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Order ID
• <code>{{3}}</code> = Delivery Date
• <code>{{4}}</code> = Time Window
• <code>{{5}}</code> = Delivery Agent Name
• <code>{{6}}</code> = Agent Contact Number

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "out_for_delivery_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "📦 Out for Delivery Today"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram Sharma"
              },
              {
                "type": "text",
                "text": "ORD-2024-78432"
              },
              {
                "type": "text",
                "text": "January 28, 2024"
              },
              {
                "type": "text",
                "text": "between 2:00 PM - 6:00 PM"
              },
              {
                "type": "text",
                "text": "Rajesh Kumar"
              },
              {
                "type": "text",
                "text": "9876543210"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "live-track-78432"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "out_for_delivery_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "📦 Out for Delivery Today"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram Sharma"},
                        {"type": "text", "text": "ORD-2024-78432"},
                        {"type": "text", "text": "January 28, 2024"},
                        {"type": "text", "text": "between 2:00 PM - 6:00 PM"},
                        {"type": "text", "text": "Rajesh Kumar"},
                        {"type": "text", "text": "9876543210"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "live-track-78432"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'out_for_delivery_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '📦 Out for Delivery Today'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram Sharma'},
          {type: 'text', text: 'ORD-2024-78432'},
          {type: 'text', text: 'January 28, 2024'},
          {type: 'text', text: 'between 2:00 PM - 6:00 PM'},
          {type: 'text', text: 'Rajesh Kumar'},
          {type: 'text', text: '9876543210'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'live-track-78432'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "out_for_delivery_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "📦 Out for Delivery Today"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Vikram Sharma"},
            {"type": "text", "text": "ORD-2024-78432"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "live-track-78432"}]}
        ]
      }
    }]
  }'

Last Mile Delivery

Send at 8 AM on delivery day. Include delivery partner contact for coordination.

Preview

Customer

online

📦 Out for Delivery Today

Hi {{1}}, your order {{2}} is out for delivery on {{3}}. Delivery window: {{4}}. Your delivery partner {{5}} ({{6}}) will contact you shortly. Please ensure someone is available to receive the package.

OTP required for delivery verification

Type a message

Preview of message sent to Customer

Appointment Reminders

Automated reminders for scheduled appointments with doctor/service provider details, location, timing, and confirmation options. Reduces no-shows by 60% for clinics, salons, and consultation businesses.

Parameters

• <code>{{1}}</code> = Service Provider Name
• <code>{{2}}</code> = Appointment Date
• <code>{{3}}</code> = Appointment Time
• <code>{{4}}</code> = Clinic/Location Address
• <code>{{5}}</code> = Duration
• <code>{{6}}</code> = Contact Number

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "appointment_reminder_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "⏰ Appointment Tomorrow"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Dr. Priya Sharma"
              },
              {
                "type": "text",
                "text": "January 29, 2024"
              },
              {
                "type": "text",
                "text": "10:30 AM"
              },
              {
                "type": "text",
                "text": "Skin Care Clinic, Andheri West"
              },
              {
                "type": "text",
                "text": "30 minutes"
              },
              {
                "type": "text",
                "text": "9876543210"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "quick_reply",
            "index": "0",
            "parameters": [
              {
                "type": "payload",
                "payload": "CONFIRM_APPOINTMENT"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "appointment_reminder_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "⏰ Appointment Tomorrow"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Dr. Priya Sharma"},
                        {"type": "text", "text": "January 29, 2024"},
                        {"type": "text", "text": "10:30 AM"},
                        {"type": "text", "text": "Skin Care Clinic, Andheri West"},
                        {"type": "text", "text": "30 minutes"},
                        {"type": "text", "text": "9876543210"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [{"type": "payload", "payload": "CONFIRM_APPOINTMENT"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'appointment_reminder_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '⏰ Appointment Tomorrow'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Dr. Priya Sharma'},
          {type: 'text', text: 'January 29, 2024'},
          {type: 'text', text: '10:30 AM'},
          {type: 'text', text: 'Skin Care Clinic, Andheri West'},
          {type: 'text', text: '30 minutes'},
          {type: 'text', text: '9876543210'}
        ]},
        { type: 'button', sub_type: 'quick_reply', index: '0', parameters: [{type: 'payload', payload: 'CONFIRM_APPOINTMENT'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "appointment_reminder_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "⏰ Appointment Tomorrow"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Dr. Priya Sharma"},
            {"type": "text", "text": "January 29, 2024"}
          ]},
          {"type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [{"type": "payload", "payload": "CONFIRM_APPOINTMENT"}]}
        ]
      }
    }]
  }'

Healthcare & Services

Send 24 hours and 2 hours before appointment. Include Quick Reply for easy confirmation.

Preview

Customer

online

⏰ Appointment Tomorrow

Hi, this is a reminder for your appointment with {{1}} scheduled for {{2}} at {{3}}. Location: {{4}}. Duration: {{5}}. For queries, call {{6}}. Please reply to confirm or reschedule.

Please arrive 10 minutes early

Type a message

Preview of message sent to Customer

Payment Confirmations

Instant payment receipts with transaction details, invoice numbers, and payment method info. Critical for financial documentation and customer trust in e-commerce transactions.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Transaction ID
• <code>{{3}}</code> = Amount Paid (Currency)
• <code>{{4}}</code> = Date & Time
• <code>{{5}}</code> = Payment Method
• <code>{{6}}</code> = Invoice Number

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "payment_success_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "✅ Payment Successful"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Ananya Patel"
              },
              {
                "type": "text",
                "text": "TXN-998877665544"
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 459900
                }
              },
              {
                "type": "text",
                "text": "January 25, 2024, 14:30 IST"
              },
              {
                "type": "text",
                "text": "Credit Card ending 4242"
              },
              {
                "type": "text",
                "text": "INV-2024-001234"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "receipt-TXN-998877665544"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "payment_success_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "✅ Payment Successful"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Ananya Patel"},
                        {"type": "text", "text": "TXN-998877665544"},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 459900}},
                        {"type": "text", "text": "January 25, 2024, 14:30 IST"},
                        {"type": "text", "text": "Credit Card ending 4242"},
                        {"type": "text", "text": "INV-2024-001234"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "receipt-TXN-998877665544"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'payment_success_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '✅ Payment Successful'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Ananya Patel'},
          {type: 'text', text: 'TXN-998877665544'},
          {type: 'currency', currency: {code: 'INR', amount_1000: 459900}},
          {type: 'text', text: 'January 25, 2024, 14:30 IST'},
          {type: 'text', text: 'Credit Card ending 4242'},
          {type: 'text', text: 'INV-2024-001234'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'receipt-TXN-998877665544'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "payment_success_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "✅ Payment Successful"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Ananya Patel"},
            {"type": "currency", "currency": {"code": "INR", "amount_1000": 459900}}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "receipt-TXN-998877665544"}]}
        ]
      }
    }]
  }'

Financial Compliance

Include transaction ID and invoice for accounting. Required for GST compliance in India.

Preview

Customer

online

✅ Payment Successful

Hi {{1}}, your payment of {{3}} has been received. Transaction ID: {{2}}. Date: {{4}}. Payment Method: {{5}}. Invoice: {{6}}. Your order is being processed and will ship within 24 hours.

This is an official receipt

Type a message

Preview of message sent to Customer

Account Updates

Security notifications for profile changes, password updates, address modifications, or payment method changes. Essential for fraud prevention and account security transparency.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Update Type (Address/Password/Email)
• <code>{{3}}</code> = Timestamp
• <code>{{4}}</code> = New Value/Details
• <code>{{5}}</code> = Device/Browser Info

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "account_update_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🔐 Account Details Updated"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rohan Mehta"
              },
              {
                "type": "text",
                "text": "Shipping Address"
              },
              {
                "type": "text",
                "text": "January 26, 2024, 11:45 AM"
              },
              {
                "type": "text",
                "text": "B-402, Sunshine Apartments, Bandra West, Mumbai 400050"
              },
              {
                "type": "text",
                "text": "Chrome on Windows"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "review-account"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "account_update_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🔐 Account Details Updated"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rohan Mehta"},
                        {"type": "text", "text": "Shipping Address"},
                        {"type": "text", "text": "January 26, 2024, 11:45 AM"},
                        {"type": "text", "text": "B-402, Sunshine Apartments, Bandra West, Mumbai 400050"},
                        {"type": "text", "text": "Chrome on Windows"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "review-account"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'account_update_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🔐 Account Details Updated'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rohan Mehta'},
          {type: 'text', text: 'Shipping Address'},
          {type: 'text', text: 'January 26, 2024, 11:45 AM'},
          {type: 'text', text: 'B-402, Sunshine Apartments, Bandra West, Mumbai 400050'},
          {type: 'text', text: 'Chrome on Windows'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'review-account'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "account_update_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🔐 Account Details Updated"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Rohan Mehta"},
            {"type": "text", "text": "Shipping Address"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "review-account"}]}
        ]
      }
    }]
  }'

Security Alert

Send immediately after any profile change. Include device info for fraud detection.

Preview

Customer

online

🔐 Account Details Updated

Hi {{1}}, your {{2}} was successfully updated on {{3}}. New details: {{4}}. Change made from: {{5}}. If you didn't make this change, please secure your account immediately.

Security is our priority

Type a message

Preview of message sent to Customer

Booking Confirmations

Hotel, flight, or event booking confirmations with complete stay details, dates, room types, and pricing. Includes cancellation policies and property information for hospitality businesses.

Parameters

• <code>{{1}}</code> = Guest Name
• <code>{{2}}</code> = Property/Hotel Name
• <code>{{3}}</code> = Stay Dates
• <code>{{4}}</code> = Duration
• <code>{{5}}</code> = Room/Seat Type
• <code>{{6}}</code> = Total Amount

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "booking_confirmed_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🏨 Booking Confirmed"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Neha Gupta"
              },
              {
                "type": "text",
                "text": "Taj Mahal Palace, Mumbai"
              },
              {
                "type": "text",
                "text": "February 14-16, 2024"
              },
              {
                "type": "text",
                "text": "2 Nights"
              },
              {
                "type": "text",
                "text": "Deluxe Sea View Room"
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 4500000
                }
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "booking-BK-998877"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "booking_confirmed_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🏨 Booking Confirmed"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Neha Gupta"},
                        {"type": "text", "text": "Taj Mahal Palace, Mumbai"},
                        {"type": "text", "text": "February 14-16, 2024"},
                        {"type": "text", "text": "2 Nights"},
                        {"type": "text", "text": "Deluxe Sea View Room"},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 4500000}}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "booking-BK-998877"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'booking_confirmed_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🏨 Booking Confirmed'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Neha Gupta'},
          {type: 'text', text: 'Taj Mahal Palace, Mumbai'},
          {type: 'text', text: 'February 14-16, 2024'},
          {type: 'text', text: '2 Nights'},
          {type: 'text', text: 'Deluxe Sea View Room'},
          {type: 'currency', currency: {code: 'INR', amount_1000: 4500000}}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'booking-BK-998877'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "booking_confirmed_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🏨 Booking Confirmed"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Neha Gupta"},
            {"type": "currency", "currency": {"code": "INR", "amount_1000": 4500000}}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "booking-BK-998877"}]}
        ]
      }
    }]
  }'

Hospitality Industry

Send immediately after booking. Include check-in instructions and property contact.

Preview

Customer

online

🏨 Booking Confirmed

Hi {{1}}, your stay at {{2}} is confirmed for {{3}} ({{4}}). Room Type: {{5}}. Total Amount: {{6}}. Check-in: 2 PM | Check-out: 12 PM. Free cancellation until 24 hours before check-in.

We look forward to hosting you

Type a message

Preview of message sent to Customer

Reservation Reminders

Restaurant table reservation reminders with venue details, party size, seating preferences, and confirmation options. Reduces no-shows for fine dining and hospitality businesses.

Parameters

• <code>{{1}}</code> = Guest Name
• <code>{{2}}</code> = Restaurant Name
• <code>{{3}}</code> = Date
• <code>{{4}}</code> = Time
• <code>{{5}}</code> = Party Size
• <code>{{6}}</code> = Seating Preference

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "reservation_reminder_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🍽️ Reservation Tomorrow"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Karan Malhotra"
              },
              {
                "type": "text",
                "text": "The Table, Colaba"
              },
              {
                "type": "text",
                "text": "January 28, 2024"
              },
              {
                "type": "text",
                "text": "8:00 PM"
              },
              {
                "type": "text",
                "text": "4 Guests"
              },
              {
                "type": "text",
                "text": "Window Table - Non Smoking"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "quick_reply",
            "index": "0",
            "parameters": [
              {
                "type": "payload",
                "payload": "CONFIRM_RESERVATION"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "reservation_reminder_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🍽️ Reservation Tomorrow"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Karan Malhotra"},
                        {"type": "text", "text": "The Table, Colaba"},
                        {"type": "text", "text": "January 28, 2024"},
                        {"type": "text", "text": "8:00 PM"},
                        {"type": "text", "text": "4 Guests"},
                        {"type": "text", "text": "Window Table - Non Smoking"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [{"type": "payload", "payload": "CONFIRM_RESERVATION"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'reservation_reminder_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🍽️ Reservation Tomorrow'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Karan Malhotra'},
          {type: 'text', text: 'The Table, Colaba'},
          {type: 'text', text: 'January 28, 2024'},
          {type: 'text', text: '8:00 PM'},
          {type: 'text', text: '4 Guests'},
          {type: 'text', text: 'Window Table - Non Smoking'}
        ]},
        { type: 'button', sub_type: 'quick_reply', index: '0', parameters: [{type: 'payload', payload: 'CONFIRM_RESERVATION'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "reservation_reminder_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🍽️ Reservation Tomorrow"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Karan Malhotra"},
            {"type": "text", "text": "The Table, Colaba"}
          ]},
          {"type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [{"type": "payload", "payload": "CONFIRM_RESERVATION"}]}
        ]
      }
    }]
  }'

Restaurant Management

Send 24 hours and 2 hours prior. Include dress code and parking info.

Preview

Customer

online

🍽️ Reservation Tomorrow

Hi {{1}}, reminder for your table at {{2}} on {{3}} at {{4}}. Party Size: {{5}}. Seating Preference: {{6}}. Please arrive within 15 minutes of reservation time. Reply to confirm or call to modify.

Dress code: Smart Casual

Type a message

Preview of message sent to Customer

Service Alerts

Platform maintenance notifications, downtime alerts, or service disruption warnings. Critical for SaaS businesses and e-commerce platforms to maintain transparency during technical operations.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Maintenance Date
• <code>{{3}}</code> = Time Window
• <code>{{4}}</code> = Duration
• <code>{{5}}</code> = Affected Services
• <code>{{6}}</code> = Action Deadline

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "service_alert_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "⚠️ Scheduled Maintenance"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Priya Sharma"
              },
              {
                "type": "text",
                "text": "January 28, 2024"
              },
              {
                "type": "text",
                "text": "2:00 AM - 6:00 AM IST"
              },
              {
                "type": "text",
                "text": "4 hours"
              },
              {
                "type": "text",
                "text": "Payment Gateway & Order Processing"
              },
              {
                "type": "text",
                "text": "January 27, 11:59 PM"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "maintenance-details"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "service_alert_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "⚠️ Scheduled Maintenance"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Priya Sharma"},
                        {"type": "text", "text": "January 28, 2024"},
                        {"type": "text", "text": "2:00 AM - 6:00 AM IST"},
                        {"type": "text", "text": "4 hours"},
                        {"type": "text", "text": "Payment Gateway & Order Processing"},
                        {"type": "text", "text": "January 27, 11:59 PM"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "maintenance-details"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'service_alert_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '⚠️ Scheduled Maintenance'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Priya Sharma'},
          {type: 'text', text: 'January 28, 2024'},
          {type: 'text', text: '2:00 AM - 6:00 AM IST'},
          {type: 'text', text: '4 hours'},
          {type: 'text', text: 'Payment Gateway & Order Processing'},
          {type: 'text', text: 'January 27, 11:59 PM'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'maintenance-details'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "service_alert_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "⚠️ Scheduled Maintenance"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Priya Sharma"},
            {"type": "text", "text": "January 28, 2024"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "maintenance-details"}]}
        ]
      }
    }]
  }'

Proactive Communication

Send 48 hours in advance for planned maintenance. Include status page link.

Preview

Customer

online

⚠️ Scheduled Maintenance

Hi {{1}}, our platform will undergo maintenance on {{2}} from {{3}} (Duration: {{4}}). Affected services: {{5}}. Please complete transactions before {{6}}. We apologize for inconvenience.

Status page: status.example.com

Type a message

Preview of message sent to Customer

Transaction Receipts

Detailed transaction receipts for billing and accounting purposes. Includes GST information, service descriptions, payment methods, and downloadable PDF links for business expense claims.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Transaction Reference
• <code>{{3}}</code> = Date & Time
• <code>{{4}}</code> = Amount (Currency)
• <code>{{5}}</code> = Service Description
• <code>{{6}}</code> = Payment Gateway

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "transaction_receipt_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🧾 Transaction Receipt"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Ankit Verma"
              },
              {
                "type": "text",
                "text": "TXN-WEB-8877665544"
              },
              {
                "type": "date_time",
                "date_time": {
                  "fallback_value": "January 25, 2024 at 3:45 PM"
                }
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 1250000
                }
              },
              {
                "type": "text",
                "text": "Premium Annual Subscription"
              },
              {
                "type": "text",
                "text": "Razorpay"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "receipt-TXN-WEB-8877665544"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "transaction_receipt_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🧾 Transaction Receipt"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Ankit Verma"},
                        {"type": "text", "text": "TXN-WEB-8877665544"},
                        {"type": "date_time", "date_time": {"fallback_value": "January 25, 2024 at 3:45 PM"}},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 1250000}},
                        {"type": "text", "text": "Premium Annual Subscription"},
                        {"type": "text", "text": "Razorpay"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "receipt-TXN-WEB-8877665544"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'transaction_receipt_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🧾 Transaction Receipt'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Ankit Verma'},
          {type: 'text', text: 'TXN-WEB-8877665544'},
          {type: 'date_time', date_time: {fallback_value: 'January 25, 2024 at 3:45 PM'}},
          {type: 'currency', currency: {code: 'INR', amount_1000: 1250000}},
          {type: 'text', text: 'Premium Annual Subscription'},
          {type: 'text', text: 'Razorpay'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'receipt-TXN-WEB-8877665544'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "transaction_receipt_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🧾 Transaction Receipt"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Ankit Verma"},
            {"type": "currency", "currency": {"code": "INR", "amount_1000": 1250000}}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "receipt-TXN-WEB-8877665544"}]}
        ]
      }
    }]
  }'

Tax Compliance

Include GSTIN and HSN codes for B2B transactions. PDF must be digitally signed.

Preview

Customer

online

🧾 Transaction Receipt

Hi {{1}}, your payment was successful. Transaction ID: {{2}}. Date: {{3}}. Amount: {{4}}. For: {{5}}. Payment Method: {{6}}. This serves as your official receipt for accounting purposes.

GST Invoice: GSTIN-29ABCDE1234F1Z5

Type a message

Preview of message sent to Customer

Appointment Cancellations

Professional cancellation notices with reasons, alternative time slots, and rescheduling options. Maintains customer trust during schedule changes for healthcare and service appointments.

Parameters

• <code>{{1}}</code> = Service Provider
• <code>{{2}}</code> = Original Date & Time
• <code>{{3}}</code> = Location
• <code>{{4}}</code> = Cancellation Reason
• <code>{{5}}</code> = Alternative Slot
• <code>{{6}}</code> = Contact Number

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "appointment_cancelled_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "❌ Appointment Cancelled"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Dr. Sarah Johnson"
              },
              {
                "type": "text",
                "text": "January 29, 2024 at 10:30 AM"
              },
              {
                "type": "text",
                "text": "Skin Care Clinic, Andheri"
              },
              {
                "type": "text",
                "text": "Doctor unavailable due to emergency"
              },
              {
                "type": "text",
                "text": "February 5, 2024 at 11:00 AM"
              },
              {
                "type": "text",
                "text": "9876543210"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "quick_reply",
            "index": "0",
            "parameters": [
              {
                "type": "payload",
                "payload": "RESCHEDULE_CONFIRM"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "appointment_cancelled_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "❌ Appointment Cancelled"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Dr. Sarah Johnson"},
                        {"type": "text", "text": "January 29, 2024 at 10:30 AM"},
                        {"type": "text", "text": "Skin Care Clinic, Andheri"},
                        {"type": "text", "text": "Doctor unavailable due to emergency"},
                        {"type": "text", "text": "February 5, 2024 at 11:00 AM"},
                        {"type": "text", "text": "9876543210"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": "0",
                    "parameters": [{"type": "payload", "payload": "RESCHEDULE_CONFIRM"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'appointment_cancelled_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '❌ Appointment Cancelled'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Dr. Sarah Johnson'},
          {type: 'text', text: 'January 29, 2024 at 10:30 AM'},
          {type: 'text', text: 'Skin Care Clinic, Andheri'},
          {type: 'text', text: 'Doctor unavailable due to emergency'},
          {type: 'text', text: 'February 5, 2024 at 11:00 AM'},
          {type: 'text', text: '9876543210'}
        ]},
        { type: 'button', sub_type: 'quick_reply', index: '0', parameters: [{type: 'payload', payload: 'RESCHEDULE_CONFIRM'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "appointment_cancelled_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "❌ Appointment Cancelled"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Dr. Sarah Johnson"},
            {"type": "text", "text": "January 29, 2024 at 10:30 AM"}
          ]},
          {"type": "button", "sub_type": "quick_reply", "index": "0", "parameters": [{"type": "payload", "payload": "RESCHEDULE_CONFIRM"}]}
        ]
      }
    }]
  }'

Crisis Management

Always provide alternative slot and reason. Offer refund if rescheduling doesn't work.

Preview

Customer

online

❌ Appointment Cancelled

Hi, your appointment with {{1}} scheduled for {{2}} at {{3}} has been cancelled. Reason: {{4}}. We apologize for inconvenience. New proposed slot: {{5}}. Call {{6}} to reschedule or confirm below.

Refund processed within 24 hours

Type a message

Preview of message sent to Customer

Payment Reminders

Invoice due date reminders with amount, late fee warnings, and secure payment links. Critical for subscription businesses, EMI collections, and B2B payment cycles to improve cash flow.

Parameters

• <code>{{1}}</code> = Customer Name
• <code>{{2}}</code> = Invoice Number
• <code>{{3}}</code> = Amount Due (Currency)
• <code>{{4}}</code> = Due Date
• <code>{{5}}</code> = Time Remaining
• <code>{{6}}</code> = Late Fee Warning

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "payment_due_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "💳 Payment Due Soon"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rohan Kapoor"
              },
              {
                "type": "text",
                "text": "INV-2024-001234"
              },
              {
                "type": "currency",
                "currency": {
                  "code": "INR",
                  "amount_1000": 499900
                }
              },
              {
                "type": "text",
                "text": "January 30, 2024"
              },
              {
                "type": "text",
                "text": "3 days"
              },
              {
                "type": "text",
                "text": "Late fee: ₹250"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "pay-INV-2024-001234"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "payment_due_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "💳 Payment Due Soon"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rohan Kapoor"},
                        {"type": "text", "text": "INV-2024-001234"},
                        {"type": "currency", "currency": {"code": "INR", "amount_1000": 499900}},
                        {"type": "text", "text": "January 30, 2024"},
                        {"type": "text", "text": "3 days"},
                        {"type": "text", "text": "Late fee: ₹250"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "pay-INV-2024-001234"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'payment_due_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '💳 Payment Due Soon'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rohan Kapoor'},
          {type: 'text', text: 'INV-2024-001234'},
          {type: 'currency', currency: {code: 'INR', amount_1000: 499900}},
          {type: 'text', text: 'January 30, 2024'},
          {type: 'text', text: '3 days'},
          {type: 'text', text: 'Late fee: ₹250'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'pay-INV-2024-001234'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "payment_due_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "💳 Payment Due Soon"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Rohan Kapoor"},
            {"type": "currency", "currency": {"code": "INR", "amount_1000": 499900}}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "pay-INV-2024-001234"}]}
        ]
      }
    }]
  }'

Collection Strategy

Send 3 days before, 1 day before, and on due date. Include late fee to create urgency.

Preview

Customer

online

💳 Payment Due Soon

Hi {{1}}, invoice {{2}} for {{3}} is due on {{4}} ({{5}} remaining). Avoid {{6}} by paying now. Secure payment link below. Multiple payment methods accepted including UPI, Cards, and Net Banking.

Auto-debit enabled on file

Type a message

Preview of message sent to Customer

Login Alerts

Real-time security notifications when account access is detected from new devices or locations. Includes device fingerprinting, geolocation, and timestamp for complete audit trails. Critical for detecting unauthorized access in banking, crypto, and high-security applications.

Alert Parameters

• <code>{{1}}</code> = Account Holder Name
• <code>{{2}}</code> = Login Timestamp
• <code>{{3}}</code> = Device Information
• <code>{{4}}</code> = Location (City/State)
• <code>{{5}}</code> = Browser/App Details

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "new_login_alert_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🔔 New Login Detected"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram Sharma"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 2:34 PM IST"
              },
              {
                "type": "text",
                "text": "iPhone 15 Pro - iOS 17"
              },
              {
                "type": "text",
                "text": "Mumbai, Maharashtra"
              },
              {
                "type": "text",
                "text": "Chrome Browser"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "secure-account-now"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "new_login_alert_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🔔 New Login Detected"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram Sharma"},
                        {"type": "text", "text": "January 28, 2024 at 2:34 PM IST"},
                        {"type": "text", "text": "iPhone 15 Pro - iOS 17"},
                        {"type": "text", "text": "Mumbai, Maharashtra"},
                        {"type": "text", "text": "Chrome Browser"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "secure-account-now"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'new_login_alert_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🔔 New Login Detected'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram Sharma'},
          {type: 'text', text: 'January 28, 2024 at 2:34 PM IST'},
          {type: 'text', text: 'iPhone 15 Pro - iOS 17'},
          {type: 'text', text: 'Mumbai, Maharashtra'},
          {type: 'text', text: 'Chrome Browser'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'secure-account-now'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "new_login_alert_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🔔 New Login Detected"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Vikram Sharma"},
            {"type": "text", "text": "January 28, 2024 at 2:34 PM IST"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "secure-account-now"}]}
        ]
      }
    }]
  }'

Fraud Prevention

Send immediately on new device detection. Include IP address in backend logs for forensics.

Preview

Customer

online

🔔 New Login Detected

Hi {{1}}, we noticed a new login to your account on {{2}}. Device: {{3}}. Location: {{4}}. Browser: {{5}}. If this wasn't you, secure your account immediately by clicking below.

We send these alerts to keep your account safe

Type a message

Preview of message sent to Customer

Security Alerts

Critical security warnings for suspicious activities like multiple failed login attempts, password changes, or unauthorized access attempts. Triggers immediate account lockdown procedures and forces password resets to prevent account takeover attacks.

Threat Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = Threat Type (Failed attempts/Password change)
• <code>{{3}}</code> = Detection Timestamp
• <code>{{4}}</code> = Suspicious Location
• <code>{{5}}</code> = Lockout Duration

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "security_breach_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🚨 Security Alert"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Ananya Patel"
              },
              {
                "type": "text",
                "text": "3 failed login attempts"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 11:23 PM"
              },
              {
                "type": "text",
                "text": "Delhi, India"
              },
              {
                "type": "text",
                "text": "15 minutes"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "secure-account-immediately"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "security_breach_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🚨 Security Alert"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Ananya Patel"},
                        {"type": "text", "text": "3 failed login attempts"},
                        {"type": "text", "text": "January 28, 2024 at 11:23 PM"},
                        {"type": "text", "text": "Delhi, India"},
                        {"type": "text", "text": "15 minutes"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "secure-account-immediately"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'security_breach_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🚨 Security Alert'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Ananya Patel'},
          {type: 'text', text: '3 failed login attempts'},
          {type: 'text', text: 'January 28, 2024 at 11:23 PM'},
          {type: 'text', text: 'Delhi, India'},
          {type: 'text', text: '15 minutes'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'secure-account-immediately'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "security_breach_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🚨 Security Alert"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Ananya Patel"},
            {"type": "text", "text": "3 failed login attempts"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "secure-account-immediately"}]}
        ]
      }
    }]
  }'

Incident Response

Auto-lock account after 3 failed attempts. Force password reset before unlock.

Preview

Customer

online

🚨 Security Alert

Hi {{1}}, we detected {{2}} on your account from {{3}} in {{4}}. Your account has been temporarily locked for {{5}}. If this wasn't you, secure your account immediately by clicking below.

Your security is our top priority

Type a message

Preview of message sent to Customer

Account Verification

Initial account verification during signup to confirm phone number ownership. Required for KYC compliance in fintech and to unlock full platform features. Includes both email and phone verification status for complete identity confirmation.

Verification Parameters

• <code>{{1}}</code> = User Full Name
• <code>{{2}}</code> = Email Address
• <code>{{3}}</code> = Mobile Number
• <code>{{4}}</code> = Verification Code
• <code>{{5}}</code> = Validity (hours)

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "account_verification_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "✅ Verify Your Account"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rohan Mehta"
              },
              {
                "type": "text",
                "text": "[email protected]"
              },
              {
                "type": "text",
                "text": "919999999999"
              },
              {
                "type": "text",
                "text": "882736"
              },
              {
                "type": "text",
                "text": "24"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "882736"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "account_verification_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "✅ Verify Your Account"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rohan Mehta"},
                        {"type": "text", "text": "[email protected]"},
                        {"type": "text", "text": "919999999999"},
                        {"type": "text", "text": "882736"},
                        {"type": "text", "text": "24"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "882736"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'account_verification_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '✅ Verify Your Account'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rohan Mehta'},
          {type: 'text', text: '[email protected]'},
          {type: 'text', text: '919999999999'},
          {type: 'text', text: '882736'},
          {type: 'text', text: '24'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: '882736'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "account_verification_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "✅ Verify Your Account"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Rohan Mehta"},
            {"type": "text", "text": "882736"}
          ]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "882736"}]}
        ]
      }
    }]
  }'

KYC Compliance

Required for financial services. Verify within 24 hours or account remains restricted.

Preview

Customer

online

✅ Verify Your Account

Hi {{1}}, verify your account to unlock full features. Email: {{2}}. Mobile: {{3}}. Your verification code is: {{4}}. Code expires in {{5}} hours. Never share this code with anyone.

Unverified accounts are limited to browsing only

Type a message

Preview of message sent to Customer

Password Reset

Secure password reset links with request metadata including timestamp, device, and location for user verification. Single-use tokens with short expiry prevent replay attacks and unauthorized password changes. Essential for account recovery flows.

Reset Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = Request Timestamp
• <code>{{3}}</code> = Request Device
• <code>{{4}}</code> = Request Location
• <code>{{5}}</code> = Link Expiry (minutes)

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "password_reset_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🔑 Password Reset Request"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Neha Gupta"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 3:15 PM"
              },
              {
                "type": "text",
                "text": "Chrome on Windows"
              },
              {
                "type": "text",
                "text": "Mumbai, India"
              },
              {
                "type": "text",
                "text": "15"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "reset-password-token-xyz"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "password_reset_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🔑 Password Reset Request"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Neha Gupta"},
                        {"type": "text", "text": "January 28, 2024 at 3:15 PM"},
                        {"type": "text", "text": "Chrome on Windows"},
                        {"type": "text", "text": "Mumbai, India"},
                        {"type": "text", "text": "15"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "reset-password-token-xyz"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'password_reset_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🔑 Password Reset Request'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Neha Gupta'},
          {type: 'text', text: 'January 28, 2024 at 3:15 PM'},
          {type: 'text', text: 'Chrome on Windows'},
          {type: 'text', text: 'Mumbai, India'},
          {type: 'text', text: '15'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'reset-password-token-xyz'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "password_reset_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🔑 Password Reset Request"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Neha Gupta"},
            {"type": "text", "text": "January 28, 2024 at 3:15 PM"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "reset-password-token-xyz"}]}
        ]
      }
    }]
  }'

Security Token

Use cryptographically secure random tokens. Invalidate link after use or 15 minutes.

Preview

Customer

online

🔑 Password Reset Request

Hi {{1}}, we received a password reset request on {{2}} from {{3}} in {{4}}. Click below to reset your password. This link expires in {{5}} minutes. If you didn't request this, ignore this message or secure your account.

Never share reset links with anyone

Type a message

Preview of message sent to Customer

Two-Factor Authentication

Secondary verification codes for high-value transactions, sensitive settings changes, or admin panel access. Adds extra security layer beyond passwords for financial transactions above threshold limits or critical account modifications.

2FA Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = 6-Digit 2FA Code
• <code>{{3}}</code> = Validity (minutes)
• <code>{{4}}</code> = Action Context (transaction type)

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "two_factor_auth_v1",
        "language": "en",
        "components": [
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Karan Malhotra"
              },
              {
                "type": "text",
                "text": "482915"
              },
              {
                "type": "text",
                "text": "5"
              },
              {
                "type": "text",
                "text": "high-value transaction of ₹25,000"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "482915"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "two_factor_auth_v1",
            "language": "en",
            "components": [
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Karan Malhotra"},
                        {"type": "text", "text": "482915"},
                        {"type": "text", "text": "5"},
                        {"type": "text", "text": "high-value transaction of ₹25,000"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "482915"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'two_factor_auth_v1',
      language: 'en',
      components: [
        { type: 'body', parameters: [
          {type: 'text', text: 'Karan Malhotra'},
          {type: 'text', text: '482915'},
          {type: 'text', text: '5'},
          {type: 'text', text: 'high-value transaction of ₹25,000'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: '482915'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "two_factor_auth_v1",
        "components": [
          {"type": "body", "parameters": [{"type": "text", "text": "Karan Malhotra"}, {"type": "text", "text": "482915"}]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "482915"}]}
        ]
      }
    }]
  }'

High Security

Mandate 2FA for transactions above ₹10,000. Use TOTP for additional security layer.

Preview

Customer

online

🔐 Hi {{1}}, your 2FA code is: {{2}}. Valid for {{3}} minutes. Required for {{4}}. This adds an extra layer of security to your account. Never share this code with anyone.

Enable 2FA in security settings for all transactions

Type a message

Preview of message sent to Customer

Device Authorization

Approve or deny access from new devices with detailed device fingerprinting. Prevents account takeover by requiring explicit authorization for unrecognized devices, even with correct passwords. Critical for protecting accounts from credential stuffing attacks.

Device Parameters

• <code>{{1}}</code> = Account Owner Name
• <code>{{2}}</code> = Device Model
• <code>{{3}}</code> = Browser/App
• <code>{{4}}</code> = Location
• <code>{{5}}</code> = Timestamp

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "device_auth_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "📱 Authorize New Device"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Priya Sharma"
              },
              {
                "type": "text",
                "text": "iPhone 14 Pro"
              },
              {
                "type": "text",
                "text": "Safari Browser"
              },
              {
                "type": "text",
                "text": "Delhi, India"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 4:45 PM"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "approve-device-auth"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "device_auth_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "📱 Authorize New Device"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Priya Sharma"},
                        {"type": "text", "text": "iPhone 14 Pro"},
                        {"type": "text", "text": "Safari Browser"},
                        {"type": "text", "text": "Delhi, India"},
                        {"type": "text", "text": "January 28, 2024 at 4:45 PM"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "approve-device-auth"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'device_auth_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '📱 Authorize New Device'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Priya Sharma'},
          {type: 'text', text: 'iPhone 14 Pro'},
          {type: 'text', text: 'Safari Browser'},
          {type: 'text', text: 'Delhi, India'},
          {type: 'text', text: 'January 28, 2024 at 4:45 PM'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'approve-device-auth'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "device_auth_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "📱 Authorize New Device"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Priya Sharma"},
            {"type": "text", "text": "iPhone 14 Pro"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "approve-device-auth"}]}
        ]
      }
    }]
  }'

Device Management

Block login until authorized. Send deny option separately for immediate account lock.

Preview

Customer

online

📱 Authorize New Device

Hi {{1}}, someone is trying to access your account from {{2}} using {{3}} in {{4}} at {{5}}. Was this you? Click below to approve or deny this access.

Deny if you don't recognize this device

Type a message

Preview of message sent to Customer

Suspicious Activity Alerts

Advanced threat detection alerts for brute force attacks, impossible travel scenarios, or unusual transaction patterns. Automatically triggers account lockdown and forces password reset to prevent unauthorized access from compromised credentials.

Threat Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = Suspicious Activity Type
• <code>{{3}}</code> = Detection Time
• <code>{{4}}</code> = Device Information
• <code>{{5}}</code> = Geolocation

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "suspicious_activity_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "⚠️ Unusual Activity Detected"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Rahul Verma"
              },
              {
                "type": "text",
                "text": "5 rapid login attempts"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 11:45 PM"
              },
              {
                "type": "text",
                "text": "Unknown Device - Android"
              },
              {
                "type": "text",
                "text": "Kolkata, West Bengal"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "secure-account-now"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "suspicious_activity_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "⚠️ Unusual Activity Detected"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Rahul Verma"},
                        {"type": "text", "text": "5 rapid login attempts"},
                        {"type": "text", "text": "January 28, 2024 at 11:45 PM"},
                        {"type": "text", "text": "Unknown Device - Android"},
                        {"type: "text", "text": "Kolkata, West Bengal"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "secure-account-now"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'suspicious_activity_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '⚠️ Unusual Activity Detected'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Rahul Verma'},
          {type: 'text', text: '5 rapid login attempts'},
          {type: 'text', text: 'January 28, 2024 at 11:45 PM'},
          {type: 'text', text: 'Unknown Device - Android'},
          {type: 'text', text: 'Kolkata, West Bengal'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'secure-account-now'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "suspicious_activity_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "⚠️ Unusual Activity Detected"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Rahul Verma"},
            {"type": "text", "text": "5 rapid login attempts"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "secure-account-now"}]}
        ]
      }
    }]
  }'

Fraud Detection

Use ML models to detect impossible travel (login from Delhi then Kolkata within 1 hour).

Preview

Customer

online

⚠️ Unusual Activity Detected

🚨 Hi {{1}}, we detected {{2}} on your account at {{3}} from {{4}} in {{5}}. This looks suspicious and we've temporarily secured your account. Click below to review and secure your account immediately.

Account locked until verification complete

Type a message

Preview of message sent to Customer

Account Recovery

Secure account restoration process for locked or compromised accounts. Includes detailed request metadata (device, location, IP) to help users verify legitimacy and prevent unauthorized access attempts.

Security Parameters

• <code>{{1}}</code> = Account Holder Name
• <code>{{2}}</code> = Registered Email
• <code>{{3}}</code> = Request Timestamp
• <code>{{4}}</code> = Device & Browser
• <code>{{5}}</code> = Geographic Location
• <code>{{6}}</code> = IP Address

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "account_recovery_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🆘 Account Recovery Request"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Vikram Sharma"
              },
              {
                "type": "text",
                "text": "[email protected]"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 3:45 PM IST"
              },
              {
                "type": "text",
                "text": "Chrome on Windows 10"
              },
              {
                "type": "text",
                "text": "Mumbai, Maharashtra"
              },
              {
                "type": "text",
                "text": "IP: 203.192.12.45"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "recover-account-78432"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "account_recovery_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🆘 Account Recovery Request"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Vikram Sharma"},
                        {"type": "text", "text": "[email protected]"},
                        {"type": "text", "text": "January 28, 2024 at 3:45 PM IST"},
                        {"type": "text", "text": "Chrome on Windows 10"},
                        {"type": "text", "text": "Mumbai, Maharashtra"},
                        {"type": "text", "text": "IP: 203.192.12.45"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "recover-account-78432"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'account_recovery_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🆘 Account Recovery Request'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Vikram Sharma'},
          {type: 'text', text: '[email protected]'},
          {type: 'text', text: 'January 28, 2024 at 3:45 PM IST'},
          {type: 'text', text: 'Chrome on Windows 10'},
          {type: 'text', text: 'Mumbai, Maharashtra'},
          {type: 'text', text: 'IP: 203.192.12.45'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'recover-account-78432'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "account_recovery_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🆘 Account Recovery Request"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Vikram Sharma"},
            {"type": "text", "text": "[email protected]"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "recover-account-78432"}]}
        ]
      }
    }]
  }'

Security Best Practice

Include IP and location to help users identify suspicious requests. Link expires in 1 hour.

Preview

Customer

online

🆘 Account Recovery Request

Hi {{1}}, we received a request to recover your account ({{2}}) on {{3}}. Device: {{4}}. Location: {{5}}. IP Address: {{6}}. If this was you, click below to restore access. If not, ignore this message or contact support immediately.

Link expires in 1 hour for security

Type a message

Preview of message sent to Customer

Email Verification

Verify email addresses during registration or profile updates. Essential for account activation, password resets, and ensuring deliverability of important transactional emails.

Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = Email Address to Verify
• <code>{{3}}</code> = 6-Digit OTP
• <code>{{4}}</code> = Expiry Time
• <code>{{5}}</code> = Purpose (Activation/Update)
• <code>{{6}}</code> = Request Date

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "email_verify_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "📧 Verify Your Email"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Priya Patel"
              },
              {
                "type": "text",
                "text": "[email protected]"
              },
              {
                "type": "text",
                "text": "456789"
              },
              {
                "type": "text",
                "text": "15 minutes"
              },
              {
                "type": "text",
                "text": "Account Activation"
              },
              {
                "type": "text",
                "text": "January 28, 2024"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "456789"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "email_verify_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "📧 Verify Your Email"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Priya Patel"},
                        {"type": "text", "text": "[email protected]"},
                        {"type": "text", "text": "456789"},
                        {"type": "text", "text": "15 minutes"},
                        {"type": "text", "text": "Account Activation"},
                        {"type": "text", "text": "January 28, 2024"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "456789"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'email_verify_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '📧 Verify Your Email'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Priya Patel'},
          {type: 'text', text: '[email protected]'},
          {type: 'text', text: '456789'},
          {type: 'text', text: '15 minutes'},
          {type: 'text', text: 'Account Activation'},
          {type: 'text', text: 'January 28, 2024'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: '456789'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "email_verify_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "📧 Verify Your Email"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Priya Patel"},
            {"type": "text", "text": "[email protected]"}
          ]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "456789"}]}
        ]
      }
    }]
  }'

Onboarding Flow

Send immediately after registration. 15-minute expiry balances security and UX.

Preview

Customer

online

📧 Verify Your Email

Hi {{1}}, verify {{2}} to complete {{5}}. Your OTP is: {{3}}. Valid for {{4}}. Requested on {{6}}. Enter this code on the verification page or click below to copy.

Didn't request this? Ignore this message

Type a message

Preview of message sent to Customer

Phone Verification

Verify mobile numbers for WhatsApp Business API registration, two-factor authentication setup, or account security updates. Ensures the user has access to the registered device.

Parameters

• <code>{{1}}</code> = User Name
• <code>{{2}}</code> = Phone Number (Masked)
• <code>{{3}}</code> = 6-Digit OTP
• <code>{{4}}</code> = Validity Period
• <code>{{5}}</code> = Service Name
• <code>{{6}}</code> = Platform/Brand

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "phone_verify_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "📱 Verify Your Number"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Arjun Kumar"
              },
              {
                "type": "text",
                "text": "+91 98765 43210"
              },
              {
                "type": "text",
                "text": "789012"
              },
              {
                "type": "text",
                "text": "10 minutes"
              },
              {
                "type": "text",
                "text": "WhatsApp Business API"
              },
              {
                "type": "text",
                "text": "ChatMitra"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "789012"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "phone_verify_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "📱 Verify Your Number"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Arjun Kumar"},
                        {"type": "text", "text": "+91 98765 43210"},
                        {"type": "text", "text": "789012"},
                        {"type": "text", "text": "10 minutes"},
                        {"type: "text", "text": "WhatsApp Business API"},
                        {"type: "text", "text": "ChatMitra"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "789012"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'phone_verify_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '📱 Verify Your Number'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Arjun Kumar'},
          {type: 'text', text: '+91 98765 43210'},
          {type: 'text', text: '789012'},
          {type: 'text', text: '10 minutes'},
          {type: 'text', text: 'WhatsApp Business API'},
          {type: 'text', text: 'ChatMitra'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: '789012'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "phone_verify_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "📱 Verify Your Number"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Arjun Kumar"},
            {"type": "text", "text": "+91 98765 43210"}
          ]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "789012"}]}
        ]
      }
    }]
  }'

WhatsApp Onboarding

Required for WhatsApp Business API. Use 10-minute expiry for security.

Preview

Customer

online

📱 Verify Your Number

Hi {{1}}, confirm {{2}} for {{5}} registration with {{6}}. Your verification code is: {{3}}. Enter this code to verify ownership. Code expires in {{4}}. Do not share this with anyone.

This code is auto-generated

Type a message

Preview of message sent to Customer

PIN Reset

Secure transaction PIN or UPI PIN reset process for banking and payment applications. Includes card masking, request metadata, and urgent security warnings for financial services.

Security Parameters

• <code>{{1}}</code> = Account Holder Name
• <code>{{2}}</code> = Masked Card/Account Number
• <code>{{3}}</code> = Request Timestamp
• <code>{{4}}</code> = Source Application
• <code>{{5}}</code> = Location
• <code>{{6}}</code> = Link Validity

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "pin_reset_v1",
        "language": "en",
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "text",
                "text": "🔐 Transaction PIN Reset"
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Neha Gupta"
              },
              {
                "type": "text",
                "text": "**** 8842"
              },
              {
                "type": "text",
                "text": "January 28, 2024 at 2:30 PM"
              },
              {
                "type": "text",
                "text": "Mobile Banking App"
              },
              {
                "type": "text",
                "text": "Mumbai"
              },
              {
                "type": "text",
                "text": "5 minutes"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "reset-pin-now"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "pin_reset_v1",
            "language": "en",
            "components": [
                {
                    "type": "header",
                    "parameters": [{"type": "text", "text": "🔐 Transaction PIN Reset"}]
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Neha Gupta"},
                        {"type": "text", "text": "**** 8842"},
                        {"type": "text", "text": "January 28, 2024 at 2:30 PM"},
                        {"type": "text", "text": "Mobile Banking App"},
                        {"type": "text", "text": "Mumbai"},
                        {"type": "text", "text": "5 minutes"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "url",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "reset-pin-now"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'pin_reset_v1',
      language: 'en',
      components: [
        { type: 'header', parameters: [{type: 'text', text: '🔐 Transaction PIN Reset'}] },
        { type: 'body', parameters: [
          {type: 'text', text: 'Neha Gupta'},
          {type: 'text', text: '**** 8842'},
          {type: 'text', text: 'January 28, 2024 at 2:30 PM'},
          {type: 'text', text: 'Mobile Banking App'},
          {type: 'text', text: 'Mumbai'},
          {type: 'text', text: '5 minutes'}
        ]},
        { type: 'button', sub_type: 'url', index: '0', parameters: [{type: 'text', text: 'reset-pin-now'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "pin_reset_v1",
        "components": [
          {"type": "header", "parameters": [{"type": "text", "text": "🔐 Transaction PIN Reset"}]},
          {"type": "body", "parameters": [
            {"type": "text", "text": "Neha Gupta"},
            {"type": "text", "text": "**** 8842"}
          ]},
          {"type": "button", "sub_type": "url", "index": "0", "parameters": [{"type": "text", "text": "reset-pin-now"}]}
        ]
      }
    }]
  }'

Banking Security

Use 5-minute expiry for PIN resets. Always mask card numbers (**** XXXX).

Preview

Customer

online

🔐 Transaction PIN Reset

Hi {{1}}, reset request for card ending {{2}} initiated on {{3}} via {{4}} from {{5}}. Click below to set new PIN. Link expires in {{6}}. If you didn't request this, block your card immediately.

Never share your PIN with anyone

Type a message

Preview of message sent to Customer

OTP Verification

Secure one-time password delivery for login verification, transaction confirmation, or account changes. Features copy-code button for easy paste and clear security warnings. Essential for two-factor authentication and high-value transaction verification in banking and e-commerce apps.

Security Parameters

• {{1}} = 6-Digit OTP Code (auto-generated)
• {{2}} = Expiry Time (minutes)
• {{3}} = Action Context (login/payment/reset)

json

{
  "recipient_mobile_number": "919999999999",
  "messages": [
    {
      "kind": "template",
      "template": {
        "name": "otp_verification_v2",
        "language": "en",
        "components": [
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "384729"
              },
              {
                "type": "text",
                "text": "10"
              },
              {
                "type": "text",
                "text": "login to your ShopEase account"
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": "0",
            "parameters": [
              {
                "type": "text",
                "text": "384729"
              }
            ]
          }
        ]
      }
    }
  ]
}

python

import requests
url = "https://backend.chatmitra.com/developer/api/send_message"
payload = {
    "recipient_mobile_number": "919999999999",
    "messages": [{
        "kind": "template",
        "template": {
            "name": "otp_verification_v2",
            "language": "en",
            "components": [
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "384729"},
                        {"type": "text", "text": "10"},
                        {"type": "text", "text": "login to your ShopEase account"}
                    ]
                },
                {
                    "type": "button",
                    "sub_type": "copy_code",
                    "index": "0",
                    "parameters": [{"type": "text", "text": "384729"}]
                }
            ]
        }
    }]
}
headers = {"Authorization": "Bearer YOUR_TOKEN", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)

node.js

const axios = require('axios');
const payload = {
  recipient_mobile_number: '919999999999',
  messages: [{
    kind: 'template',
    template: {
      name: 'otp_verification_v2',
      language: 'en',
      components: [
        { type: 'body', parameters: [
          {type: 'text', text: '384729'},
          {type: 'text', text: '10'},
          {type: 'text', text: 'login to your ShopEase account'}
        ]},
        { type: 'button', sub_type: 'copy_code', index: '0', parameters: [{type: 'text', text: '384729'}] }
      ]
    }
  }]
};
axios.post('https://backend.chatmitra.com/developer/api/send_message', payload, {
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }
}).then(res => console.log(res.data));

curl

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "messages": [{
      "kind": "template",
      "template": {
        "name": "otp_verification_v2",
        "components": [
          {"type": "body", "parameters": [{"type": "text", "text": "384729"}, {"type": "text", "text": "10"}]},
          {"type": "button", "sub_type": "copy_code", "index": "0", "parameters": [{"type": "text", "text": "384729"}]}
        ]
      }
    }]
  }'

Security Best Practice

Never log OTPs in your system. Auto-expire after 5-10 minutes. Rate limit to 3 attempts per hour.

WhatsApp Preview

Customer

online

🔐 Your OTP is: {{1}}. Valid for {{2}} minutes only. Use this code to complete {{3}}. Never share this code with anyone, including customer support.

Didn't request this? Secure your account immediately

Type a message

Preview of message sent to Customer

AI Integration Guide for WhatsApp

Everything you need to know about connecting ChatGPT and AI assistants to your WhatsApp Business API. Follow these guidelines to create helpful, human-like conversations that your customers will love.

AI-Powered WhatsApp Messaging: The Complete Guide

Learn how to connect ChatGPT and AI assistants to your WhatsApp Business API for smarter customer conversations.

Transform Your WhatsApp Conversations with AI

Imagine having a smart assistant that never sleeps, instantly answers customer questions, and knows your business inside out—all through WhatsApp. That's exactly what AI integration with Chatmitra delivers. Whether you're running an online store, managing appointments, or handling support tickets, AI can handle the heavy lifting while you focus on growing your business.

24/7 Availability

Your customers get instant replies, even at 3 AM

80% Automation

Handle routine queries without human intervention

Human-Like Chat

Natural conversations that feel personal, not robotic

What Does AI Integration Actually Mean?

Think of it as giving your WhatsApp Business account a brain. Instead of manually typing every response or setting up rigid auto-replies, you connect Chatmitra to intelligent systems like ChatGPT, Claude, or Google Gemini. These AI models understand context, remember previous messages, and respond just like a trained human representative would.

For example, when a customer asks "Where's my order?" the AI instantly checks your database, finds their tracking number, and replies with the current status—complete with a friendly tone and helpful details. No coding required on your part, no delays, and no "Please wait while we connect you to an agent" messages.

How Does It Work Behind the Scenes?

Customer Sends a Message

Someone messages your WhatsApp Business number with a question or request.

Chatmitra Receives & Forwards to AI

Our system captures the message and sends it to your connected AI assistant along with conversation history.

AI Generates a Smart Response

The AI analyzes the intent, checks your business rules, and crafts a helpful, natural reply.

Reply Sent Instantly via WhatsApp

The response flows back through Chatmitra and appears in the customer's WhatsApp within seconds.

The 24-Hour Rule: What You Must Know

WhatsApp has a important policy: you can only send free-form AI replies within 24 hours of the customer's last message. After that, you must use pre-approved templates. Don't worry— we'll show you exactly how to handle this seamlessly so your AI never gets cut off mid-conversation.

Real-World AI Solutions for Your Industry

Practical examples of how businesses use Chatmitra AI to solve real problems and increase revenue.

Online Stores

Recover lost sales automatically

The Challenge:

70% of carts are abandoned. Customers ask "Where's my order?" 50 times a day. Returns are confusing.

The AI Solution:

Detects abandoned carts after 1 hour
Sends personalized recovery: "Forgot something? Here's 10% off!"
Tracks orders in real-time instantly
Processes returns via chat buttons

Results: 25% recovery rate, 40% less support tickets

Clinics & Salons

Never miss an appointment

The Challenge:

No-shows cost money. Phone tags waste time. Patients forget prep instructions.

The AI Solution:

Books appointments 24/7 via chat
Sends smart reminders 24h before
Answers: "Can I eat before my test?"
Reschedules with one message: "Move to Tuesday"

Results: 60% fewer no-shows, 50% faster booking

Customer Support

Instant answers, happy customers

The Challenge:

Same questions asked 100 times daily. Long wait times. Expensive support team.

The AI Solution:

Answers FAQs instantly using your knowledge base
Detects angry customers, routes to humans fast
Gathers info before handoff (order #, issue)
Creates support tickets automatically

Results: 80% instant resolution, 2min response time

Your 30-Day AI Implementation Plan

Week 1: Set Up the Basics

Connect Chatmitra to your AI (OpenAI, Claude, etc.). Start with just 10 common FAQs. Test with your team first. Don't go live yet—just make sure messages flow correctly.

Week 2: Add Memory & Context

Make the AI remember conversations. Set up the 24-hour window checker. Add "Talk to human" button. Train it on your product catalog or service details.

Week 3: Connect Your Systems

Link to your CRM, order database, or booking system so AI can check real data. Set up error handling (what happens when AI doesn't know something).

Week 4: Go Live & Monitor

Launch to 10% of customers. Watch the metrics daily. Adjust the AI's tone based on feedback. Scale up once you're seeing 90%+ success rates.

Why This Pays for Itself

₹15

Average cost per AI conversation

₹150

Average cost per human support call

90%

Savings on routine inquiries

If you handle 100 customer chats per day, AI saves you approximately ₹13,500 daily while providing instant service.

Common Errors & Solutions

400: Invalid Phone Number Format

json

{
  "status": "error",
  "message": "Phone must be 10-15 digits with country code"
}

Causes:

• Missing country code (e.g., 9999999999 instead of 919999999999)
• Contains spaces, dashes, or special characters
• Leading zero (09999999999)
• Contains + sign

Fix:

javascript

// ✗ Wrong
"recipient_mobile_number": "+91 9999 9999 99"
"recipient_mobile_number": "09999999999"

// ✓ Right
"recipient_mobile_number": "919999999999"

400: Insufficient Credits

json

{
  "status": "error",
  "message": "Insufficient credits (required: 1, available: 0)"
}

What's Happening:

First message to a NEW customer costs 1 credit (₹0.20). Replies within 24 hours are FREE. You're out of credits for starting new conversations.

Solution:

Buy more credits in Dashboard → Billing
Or wait for existing conversations (if messaging same customer within 24h window)
Check dashboard for your current credit balance

400: Template Not Found or Not Approved

json

{
  "status": "error",
  "message": "Template 'order_confirmation' not approved"
}

Causes:

• Template doesn't exist in your account
• Template pending approval (wait 1-2 hours)
• Template was rejected by Meta
• Template name has uppercase letters (must be lowercase)

Solution:

Go to Dashboard → Templates
Check template exists and shows "Approved"
Verify template name is lowercase with no spaces
If rejected, check reason and resubmit

400: Invalid Media Link

json

{
  "status": "error",
  "message": "Media link must be HTTPS and publicly accessible"
}

Causes:

• Using HTTP instead of HTTPS
• Localhost URL (http://localhost:3000/...)
• Private IP address (192.168.*, 10.*, 127.*)
• File doesn't exist at that URL
• File too large (exceeds size limit)

Fix:

json

// ✗ Wrong
"link": "http://localhost:3000/photo.jpg"
"link": "http://192.168.1.1/photo.jpg"

// ✓ Right
"link": "https://cloudinary.com/abc123.jpg"
"link": "https://s3.amazonaws.com/bucket/photo.jpg"

413: File Too Large

Solution:

Compress your file before uploading to cloud storage.

bash

# Compress Image
ffmpeg -i photo.jpg -q:v 5 photo-compressed.jpg

# Compress Video
ffmpeg -i video.mp4 -vcodec libx264 -crf 23 -preset fast video-compressed.mp4

# Compress Audio
ffmpeg -i audio.wav -b:a 128k audio.mp3

Online tools: TinyPNG (images), HandBrake (video), CloudConvert (all formats)

400: Cannot Mix Message Types

What Went Wrong:

You sent both template and raw messages (text/media) in same request. Not allowed - must send separately.

Fix:

json

// ✗ Wrong
{
  "messages": [
    { "kind": "template", ... },
    { "kind": "raw", ... }
  ]
}

// ✓ Right - Make two separate API calls
// Call 1: Send template
{ "messages": [{ "kind": "template", ... }] }

// Call 2: Send text (after delay)
{ "messages": [{ "kind": "raw", ... }] }

401: Unauthorized - Invalid Token

Causes:

• Missing Authorization header
• Token is invalid or expired
• Wrong format (must be: Bearer token)
• Token accidentally leaked/exposed

Solution:

Check Authorization header is set correctly
Regenerate token in Dashboard → Settings → API Keys
Use format: Bearer YOUR_TOKEN
Keep token in .env file, never in code

Status Code Reference

202

Accepted

Message queued successfully

400

Bad Request

Invalid input or validation failed

401

Unauthorized

Invalid or missing API token

500

Server Error

Internal error (rare, retry)

Complete API Reference

Authentication

All requests require Bearer token authentication. Get your token from Dashboard → Settings → API Keys. Prerequisites: Account must be active.

bash

curl -X POST https://backend.chatmitra.com/developer/api/send_message \
  -H "Authorization: Bearer sk_live_abc123xyz789" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient_mobile_number": "919999999999",
    "message": "Hello World!"
  }'

Multi-language examples for authentication in requests.

Keep Your Token Secure

Store tokens in environment variables, never in code. If exposed, regenerate immediately in dashboard.

Request Body Parameters

Parameter	Type	Required	Description
recipient_mobile_number	string	Yes	Customer phone with country code (10-15 digits)
message	string	Optional	Text message body (max 4096 chars)
messages	array	Optional	Array of message objects for templates/batch. Note: For batch, use to send multiple messages in one call.
customer_name	string	Optional	Customer name for personalization
altTexts	object	Optional	Fallback values for template placeholders, e.g., {"$name": "Guest"}

*Either message or messages is required. Cannot use both in same request.

Validation Rules & Limits

Text Messages

• Maximum length: 4,096 characters. Example: 'Hello' (5 chars) is fine; a 5000-char string will fail.
• Supports emojis (max 10 per message)
• No emoji-only messages allowed
• No HTML or markdown formatting
• No mixed language (Devanagari + Latin)

Templates

• Template name: 1-60 chars, lowercase + underscore only
• Body parameters: Max 10 per component
• Parameter text: Max 1,024 chars each
• Must be approved by Meta before sending
• Dynamic placeholders with fallback support

Interactive Messages

• Buttons: Max 3 per message, max 20 chars per button title
• Lists: Max 10 rows, max 20 chars per row title
• Button IDs: Max 256 characters
• Quick reply payloads: Max 256 characters

Media Files

• Images: Max 5 MB (JPG, PNG, WEBP)
• Videos: Max 16 MB (MP4, 3GP)
• Audio: Max 16 MB (MP3, OGG, OPUS)
• Documents: Max 100 MB (PDF, Office formats)
• Stickers: Max 500 KB (WEBP only)

Location Messages

• Latitude: -90 to 90
• Longitude: -180 to 180
• Name and address: Optional but recommended

Phone Number Format Guide

✓ Correct Format

• 919999999999 - India (country code 91 + 10 digits)
• 12025550123 - USA (country code 1 + 10 digits)
• 447911123456 - UK (country code 44)
• Digits only, no spaces, dashes, or + signs
• Length varies by country (e.g., 12 digits for India including 91, up to 15 total)

✗ Wrong Format (Will Fail)

• 9999999999 - Missing country code
• +91 9999999999 - Contains + and space
• 091999999999 - Leading zero (not allowed)
• 91-9999-9999-99 - Contains dashes

Auto-Clean Phone Numbers in Code

Equivalent code examples in other languages to clean phone numbers. All handle the same logic: remove non-digits, handle leading zero, add country code if needed (assuming India; customize as per use case).

node.js

function cleanPhoneNumber(phone) {
  // Remove all non-digits
  let clean = phone.replace(/D/g, '');
 
  // Remove leading 0 (for India)
  if (clean.startsWith('0')) {
    clean = clean.substring(1);
  }
 
  // Add country code if missing (assumes India) - Customize country code based on user location
  if (!clean.startsWith('91') && clean.length === 10) {
    clean = '91' + clean;
  }
 
  return clean;
}
// Usage
cleanPhoneNumber('+91 9999-9999-99'); // Returns: 919999999999 ✓
cleanPhoneNumber('09999999999'); // Returns: 919999999999 ✓

python

import re
def clean_phone_number(phone):
    # Remove all non-digits
    clean = re.sub(r'D', '', phone)
   
    # Remove leading 0 (for India)
    if clean.startswith('0'):
        clean = clean[1:]
   
    # Add country code if missing (assumes India) - Customize based on user location
    if not clean.startswith('91') and len(clean) == 10:
        clean = '91' + clean
   
    return clean
# Usage
print(clean_phone_number('+91 9999-9999-99')) # 919999999999
print(clean_phone_number('09999999999')) # 919999999999

php

<?php
function cleanPhoneNumber($phone) {
    // Remove all non-digits
    $clean = preg_replace('/D/', '', $phone);
   
    // Remove leading 0 (for India)
    if (strpos($clean, '0') === 0) {
        $clean = substr($clean, 1);
    }
   
    // Add country code if missing (assumes India) - Customize based on user location
    if (strpos($clean, '91') !== 0 && strlen($clean) === 10) {
        $clean = '91' . $clean;
    }
   
    return $clean;
}
// Usage
echo cleanPhoneNumber('+91 9999-9999-99'); // 919999999999
echo cleanPhoneNumber('09999999999'); // 919999999999
?>

java

public class PhoneCleaner {
    public static String cleanPhoneNumber(String phone) {
        // Remove all non-digits
        String clean = phone.replaceAll("\D", "");
       
        // Remove leading 0 (for India)
        if (clean.startsWith("0")) {
            clean = clean.substring(1);
        }
       
        // Add country code if missing (assumes India) - Customize based on user location
        if (!clean.startsWith("91") && clean.length() == 10) {
            clean = "91" + clean;
        }
       
        return clean;
    }
    public static void main(String[] args) {
        System.out.println(cleanPhoneNumber("+91 9999-9999-99")); // 919999999999
        System.out.println(cleanPhoneNumber("09999999999")); // 919999999999
    }
}

package main
import (
    "fmt"
    "regexp"
    "strings"
)
func cleanPhoneNumber(phone string) string {
    // Remove all non-digits
    re := regexp.MustCompile(`D`)
    clean := re.ReplaceAllString(phone, "")
   
    // Remove leading 0 (for India)
    if strings.HasPrefix(clean, "0") {
        clean = clean[1:]
    }
   
    // Add country code if missing (assumes India) - Customize based on user location
    if !strings.HasPrefix(clean, "91") && len(clean) == 10 {
        clean = "91" + clean
    }
   
    return clean
}
func main() {
    fmt.Println(cleanPhoneNumber("+91 9999-9999-99")) // 919999999999
    fmt.Println(cleanPhoneNumber("09999999999")) // 919999999999
}

ruby

def clean_phone_number(phone)
  # Remove all non-digits
  clean = phone.gsub(/D/, '')
 
  # Remove leading 0 (for India)
  clean = clean[1..-1] if clean.start_with?('0')
 
  # Add country code if missing (assumes India) - Customize based on user location
  clean = '91' + clean if !clean.start_with?('91') && clean.length == 10
 
  clean
end
# Usage
puts clean_phone_number('+91 9999-9999-99') # 919999999999
puts clean_phone_number('09999999999') # 919999999999

c# (.net)

using System;
using System.Text.RegularExpressions;
class Program {
    static string CleanPhoneNumber(string phone) {
        // Remove all non-digits
        string clean = Regex.Replace(phone, @"D", "");
       
        // Remove leading 0 (for India)
        if (clean.StartsWith("0")) {
            clean = clean.Substring(1);
        }
       
        // Add country code if missing (assumes India) - Customize based on user location
        if (!clean.StartsWith("91") && clean.Length == 10) {
            clean = "91" + clean;
        }
       
        return clean;
    }
    static void Main() {
        Console.WriteLine(CleanPhoneNumber("+91 9999-9999-99")); // 919999999999
        Console.WriteLine(CleanPhoneNumber("09999999999")); // 919999999999
    }
}

swift (ios)

func cleanPhoneNumber(_ phone: String) -> String {
    // Remove all non-digits
    let clean = phone.replacingOccurrences(of: "\D", with: "", options: .regularExpression)
   
    // Remove leading 0 (for India)
    var mutableClean = clean
    if mutableClean.hasPrefix("0") {
        mutableClean.removeFirst()
    }
   
    // Add country code if missing (assumes India) - Customize based on user location
    if !mutableClean.hasPrefix("91") && mutableClean.count == 10 {
        mutableClean = "91" + mutableClean
    }
   
    return mutableClean
}
// Usage
print(cleanPhoneNumber("+91 9999-9999-99")) // 919999999999
print(cleanPhoneNumber("09999999999")) // 919999999999

kotlin (android)

fun cleanPhoneNumber(phone: String): String {
    // Remove all non-digits
    var clean = phone.replace(Regex("\D"), "")
   
    // Remove leading 0 (for India)
    if (clean.startsWith("0")) {
        clean = clean.drop(1)
    }
   
    // Add country code if missing (assumes India) - Customize based on user location
    if (!clean.startsWith("91") && clean.length == 10) {
        clean = "91" + clean
    }
   
    return clean
}
// Usage
println(cleanPhoneNumber("+91 9999-9999-99")) // 919999999999
println(cleanPhoneNumber("09999999999")) // 919999999999

Response Examples

Success Response (202 Accepted)

json

{
  "status": "success",
  "message": "Request queued",
  "jobId": "job_abc123xyz789"
}

Error Response (400/401/500)

json

{
  "status": "error",
  "message": "Descriptive error message"
}

Best Practices

1. Phone Number Validation

Always validate and clean phone numbers before sending. Remove spaces, dashes, and special characters. Tip: Use the auto-clean function from Send Messages tab.

2. Use Templates for Repeat Messages

Templates are faster, cheaper, and have higher delivery rates. Use for order confirmations, status updates, etc.

3. Manage Credits Wisely

First message to a customer costs 1 credit. Replies within 24 hours are free. Plan messaging strategy accordingly.

4. Optimize Media Size

Compress images and videos to 1-5 MB for faster delivery. Use HTTPS CDN for media hosting.

5. Handle Errors Gracefully

Implement error logging and retry logic with exponential backoff. Log jobId for tracking.

Ready to Get Started?

Create your Chat Mitra account and send your first message in minutes.

Start Free Now

Understanding Chat Mitra API

What You Can Do

Key Concepts

Conversations

Message Types

Raw Messages

Template Messages

Templates

Queue System

Required Headers & Authentication

Base URL

Authentication

Get Started in 5 Minutes

Create Your Account

Get Your API Token

Verify Your WhatsApp Number

Install Dependencies

Send Your First Message

No Installation Needed for cURL

POST /send_message

24-Hour Window Rules & Pricing

Raw Messages Require Active 24-Hour Window

When to Use Raw Messages vs Templates

Use Raw Messages For:

Use Templates For:

Chatmitra Pricing & Conversation Costs

Conversation Categories:

Raw Message Best Practices

Raw messages (text, media, interactive) can only be sent when a 24-hour conversation window is active

Simple Text Message

Request

Preview

Response (202)

Message Sent Successfully

Send Image

Preview

How to Get Public HTTPS Links

Send Document

Preview

Send Audio

Preview

Send Location

Preview

Location Message Use Cases

Interactive Message - Buttons

Preview

Interactive Message - Dropdown List

Preview

Sending Media & Files

Supported File Types & Size Limits

HTTPS Required for All Media URLs

24-Hour Window & Media Messages

POST /send_message

Template Guidelines & Pricing

Understanding the 24-Hour Conversation Window

Marketing Templates

Utility Templates

Authentication Templates

Chatmitra Pricing & Meta Official Rates

Template Best Practices

Template Must Be Approved First

Promotional Broadcasts

Parameters

Best Practices

Preview

Seasonal Campaigns

Parameters

Festival Marketing

Preview

Product Launch

Parameters

Launch Strategy

Preview

Discounts & Offers

Parameters

Urgency Marketing

Preview

Abandoned Cart

Parameters

Recovery Strategy