Textplate SMS API Documentation

Integrate SMS into your website, mobile application, SaaS platform, or business system using the Textplate REST API. The API allows developers to send OTPs, alerts, appointment reminders, order updates, and other supported business notifications programmatically.

REST API • Bearer authentication • Pre-approved SMS templates • Dynamic variables

API Endpoint

Send SMS requests to the following Textplate API endpoint:

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

The endpoint accepts your API token and SMS request parameters. Requests should be sent using the POST method.

Authentication

Textplate API requests are authenticated using a Bearer API token. Include your API token in the Authorization header of every API request.

Authorization: Bearer YOUR_API_TOKEN

You can obtain your API token from the API keys section of your Textplate account.

Send SMS

To send an SMS, make a POST request to the Textplate send-sms endpoint with your API token and the required SMS parameters.

Textplate uses the template ID to determine the approved message template and the dynamic values supplied with your request.

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

Request Parameters

The following parameters can be used when sending an SMS through the Textplate API.

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

Parameters required for a request depend on the type of approved SMS template being used.

Mobile Number Parameter

The mobileNumber parameter specifies the recipient mobile number. Use the Indian mobile number format with the +91 country code.

Multiple mobile numbers can be supplied using a comma-separated value.

"mobileNumber": "+919100091000"

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

Template Id Parameter

The templateId parameter identifies the Textplate-approved SMS template that should be used for the message.

Select the appropriate template ID from the approved templates available in your Textplate account.

OTP SMS Parameters

For OTP templates, use otpValue and expiryValue to provide the dynamic OTP and its expiry information.

otpValue accepts a numeric OTP value with a maximum length of 10 digits.

expiryValue accepts the OTP expiry information with a maximum length of 15 characters.

"otpValue": "910910", "expiryValue": "10 minutes"

Transactional SMS Parameters

For non-OTP templates, use detailValue to provide the dynamic information required by the selected template.

The detailValue parameter supports a maximum length of 30 characters.

"detailValue": "ABC Detail"

API Request Examples

Choose your preferred programming language below to view an example request for the Textplate SMS API.

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

API Response

After submitting an API request, Textplate returns the API response containing the result of the request.

Your application can use the response to determine whether the request was accepted and handle the result within your messaging workflow.

Integrate Textplate With Your Application

You can integrate the Textplate SMS API into websites, mobile applications, SaaS platforms, CRM systems, booking systems, order management systems, and other business applications.

Once your API token and approved template IDs are available, your application can send SMS programmatically whenever your business workflow requires it.

Supported Programming Languages

Textplate provides example requests for Node.js, PHP, Python, Dart, JavaScript, and cURL so developers can integrate the API using the tools and frameworks they already use.

Ready to Integrate SMS?

Create your Textplate account, obtain your API access, and start integrating SMS into your application using the Textplate REST API.

Simple integration • Developer-friendly API • Business SMS infrastructure