Textplate Documentation

Integrate SMS into your website, mobile application, SaaS platform, or business system using the Textplate REST API. Send OTPs, alerts, appointment reminders, notifications, and other transactional SMS programmatically.

1. API Endpoint

POST https://api.textplate.in/v1/send-sms

Send SMS requests to the Textplate API using the endpoint above. Include API authentication and the required parameters in each POST request.

2. API Authentication

Authorization: Bearer YOUR_API_TOKEN

Textplate API requests use Bearer token authentication. Add your API token to the Authorization header of every request. Find your API token in the API Keys section of your Textplate account.

3. API Parameters

"mobileNumber", "templateId", "otpValue", "expiryValue", "detailValue"

i) The mobileNumber parameter specifies the recipient's mobile number. Use the Indian mobile number format with the +91 country code. You can send SMS to multiple mobile numbers by providing comma-separated numbers.

Example: "mobileNumber" : "+919100091000"

Example: "mobileNumber" : "+919100091000, +918100081000, +917100071000, +916100061000, ..."

ii) The templateId parameter identifies the built-in DLT SMS template used for the message. Select the appropriate template ID from the templates available in your Textplate account.

Example: "templateId" : "106db76a751b36cc5cbf132bc5a8edd30a1531ea"

iii) For OTP templates, use otpValue and expiryValue parameters to provide the OTP and its expiry information. The otpValue parameter accepts a numeric OTP with a maximum length of 10 digits. The expiryValue parameter accepts the OTP expiry information with a maximum length of 15 characters.

Example: "otpValue" : "910910"

Example: "expiryValue" : "10 minutes"

iv) For non-OTP templates, use detailValue parameter to provide the dynamic information required by the template. The detailValue parameter supports a maximum length of 30 characters.

Example: "detailValue" : "ABC Detail"

4. API Request

NodeJs

PHP

Python

Dart

JavaScript

cURL

var fetch = require("request");

var url = "https://api.textplate.in/v1/send-sms";

var head = {
    "Authorization" : "Bearer YOUR_API_TOKEN"  // Copy from Textplate API keys
};

var form = {
    "mobileNumber"  : "YOUR_MOBILE_NUMBER",    // +91XXXXXXXXXX, multiple allowed with comma (,)
    "templateId"    : "YOUR_TEMPLATE_ID",      // Select from Textplate approved templates
    "otpValue"      : "YOUR_OTP_VALUE",        // OTP templates only, max 10 digits
    "expiryValue"   : "YOUR_EXPIRY_VALUE",     // OTP templates only, max 15 chars
    "detailValue"   : "YOUR_DETAIL_VALUE"      // Non-OTP templates, max 30 chars
};

var option = {
    method      : "POST",
    url         : url,
    headers     : head,
    formData    : form
};

fetch(option, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

$fetch = curl_init();

$url = "https://api.textplate.in/v1/send-sms";

$head = array(
    "Authorization: Bearer YOUR_API_TOKEN"     // Copy from Textplate API keys
);

$form = array(
    "mobileNumber"  => "YOUR_MOBILE_NUMBER",   // +91XXXXXXXXXX, multiple allowed with comma (,)
    "templateId"    => "YOUR_TEMPLATE_ID",     // Select from Textplate approved templates
    "otpValue"      => "YOUR_OTP_VALUE",       // OTP templates only, max 10 digits
    "expiryValue"   => "YOUR_EXPIRY_VALUE",    // OTP templates only, max 15 chars
    "detailValue"   => "YOUR_DETAIL_VALUE"     // Non-OTP templates, max 30 chars
);

$option = array(
    CURLOPT_CUSTOMREQUEST   => "POST",
    CURLOPT_URL             => $url,
    CURLOPT_HTTPHEADER      => $head,
    CURLOPT_POSTFIELDS      => $form
);

curl_setopt_array($fetch, $option);
$response = curl_exec($fetch);
curl_close($fetch);
echo $response;

import requests as fetch

url = "https://api.textplate.in/v1/send-sms"

head = {
    "Authorization" : "Bearer YOUR_API_TOKEN"   # Copy from Textplate API keys
}

form = {
    "mobileNumber"  : "YOUR_MOBILE_NUMBER",     # +91XXXXXXXXXX, multiple allowed with comma (,)
    "templateId"    : "YOUR_TEMPLATE_ID",       # Select from Textplate approved templates
    "otpValue"      : "YOUR_OTP_VALUE",         # OTP templates only, max 10 digits
    "expiryValue"   : "YOUR_EXPIRY_VALUE",      # OTP templates only, max 15 chars
    "detailValue"   : "YOUR_DETAIL_VALUE"       # Non-OTP templates, max 30 chars
}

option = {
    "method"    : "POST",
    "url"       : url,
    "headers"   : head,
    "data"      : form
}

response = fetch.request(option["method"], option["url"], 
    headers=option["headers"], data=option["data"]
)
print(response.text)

import 'package:http/http.dart' as fetch;
    
var url = "https://api.textplate.in/v1/send-sms";

var head = {
    "Authorization" : "Bearer YOUR_API_TOKEN"  // Copy from Textplate API keys
};

var form = {
    "mobileNumber"  : "YOUR_MOBILE_NUMBER",    // +91XXXXXXXXXX, multiple allowed with comma (,)
    "templateId"    : "YOUR_TEMPLATE_ID",      // Select from Textplate approved templates
    "otpValue"      : "YOUR_OTP_VALUE",        // OTP templates only, max 10 digits
    "expiryValue"   : "YOUR_EXPIRY_VALUE",     // OTP templates only, max 15 chars
    "detailValue"   : "YOUR_DETAIL_VALUE"      // Non-OTP templates, max 30 chars
};
    
var option = fetch.MultipartRequest("POST", Uri.parse(url));

option.headers.addAll(head);
option.fields.addAll(form);

var response = await option.send();
if (response.statusCode == 200) {
    print(await response.stream.bytesToString());
} else {
    print(response.reasonPhrase);
}

var url = "https://api.textplate.in/v1/send-sms";

var head = new Headers();
head.append("Authorization", "Bearer YOUR_API_TOKEN"); // Copy from Textplate API keys

var form = new FormData();
form.append("mobileNumber", "YOUR_MOBILE_NUMBER");     // +91XXXXXXXXXX, multiple allowed with comma (,)
form.append("templateId", "YOUR_TEMPLATE_ID");         // Select from Textplate approved templates
form.append("otpValue", "YOUR_OTP_VALUE");             // OTP templates only, max 10 digits
form.append("expiryValue", "YOUR_EXPIRY_VALUE");       // OTP templates only, max 15 chars
form.append("detailValue", "YOUR_DETAIL_VALUE");       // Non-OTP templates, max 30 chars

var option = {
    method  : "POST",
    headers : head,
    body    : form
};

fetch(url, option)
    .then((response) => response.text())
    .then((result) => console.log(result))
    .catch((error) => console.error(error));

curl -X POST https://api.textplate.in/v1/send-sms \
-H "Authorization: Bearer YOUR_API_TOKEN" \   # Copy from Textplate API keys
-F "mobileNumber=YOUR_MOBILE_NUMBER" \        # +91XXXXXXXXXX, multiple allowed with comma (,)
-F "templateId=YOUR_TEMPLATE_ID" \            # Select from Textplate approved templates
-F "otpValue=YOUR_OTP_VALUE" \                # OTP templates only, max 10 digits
-F "expiryValue=YOUR_EXPIRY_VALUE" \          # OTP templates only, max 15 chars
-F "detailValue=YOUR_DETAIL_VALUE"            # Non-OTP templates, max 30 chars

5. API Response

Textplate returns a response after processing your API request. Use the response to determine whether the SMS request was accepted and handle the result in your application.

Start Free with 7 Days of Access and 20 SMS Credits - No Payment Required

Create a Textplate account today and get started with 7 days of free access and 20 SMS credits, with no upfront payment or commitment required. Explore the dashboard, test SMS delivery, try built-in DLT templates, and integrate SMS into a website, application, or business system.

7 days free access • 20 SMS credits included • No payment required

Create Free Account

Secure & Trusted

No Hidden Charges

24/7 Support

Made In India