Add New Template Bulk SMS API Documentation

Add New Template

Add New Template

Application API URL:

https://www.smsgateway.center/library/api/self/Templates/

 

Key Value Description
Login Credentials (Required Parameters)
Authenticate your API request using userId-password or apiKey. You should use either one to authenticate your login.
userId Your Registered Username The registered username parameter to be passed. You can use this if apiKey is not being used.
password Your password The password needs to be urlencoded if there are any special characters used in the password field. You can use this if apiKey is not being used.
apiKey Your unique apiKey apiKey needs to be sent as HTTP header when you are not using userId and password credentials. You can avail this from your user control panel and use instead of userId and password HTTP Request parameter. Please do not disclose this to anyone.
Required Parameters
do add Action value for do parameter
messageContent Message Content Your message content to be saved as transactional template.
format plain|json|xml Value for response format.

System default is plain. If you need responses in JSON or XML then you have to give value as JSON or XML.
Code Description
Success code and Response
900 Your Template has been successfully updated and awaiting for moderation.
Error codes and Response
2559 Message Content required.
2560 Message Content is too long.
2561 Message Content is too short.
2572 Template ID required.
2573 Template Message Content already exists.

Save this Page on your Favorite Social Media

Sample Request Code

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.smsgateway.center/library/api/self/Templates/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "userId=YourUsername&password=YourCurrentPassword&do=add&messageContent=Your%20verification%20code%20is%24__123__%24&format=json",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.smsgateway.center/library/api/self/Templates/?userId=YourUsername&password=YourCurrentPassword&do=add&messageContent=Your%20verification%20code%20is%24__123__%24&format=json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
var qs = require("querystring");
var http = require("https");

var options = {
  "method": "POST",
  "hostname": "www.smsgateway.center",
  "port": null,
  "path": "/library/api/self/Templates/",
  "headers": {
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(qs.stringify({ userId: 'YourUsername',
  password: 'YourCurrentPassword',
  do: 'add',
  messageContent: 'Your verification code is$__123__$',format: 'json' }));
req.end();
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "www.smsgateway.center",
  "port": null,
  "path": "/library/api/self/Templates/?userId=YourUsername&password=YourCurrentPassword&do=add&messageContent=Your%20verification%20code%20is%24__123__%24&format=json",
  "headers": {
    "cache-control": "no-cache"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "userId=YourUsername&password=YourCurrentPassword&do=add&messageContent=Your%20verification%20code%20is%24__123__%24&format=json");
Request request = new Request.Builder()
  .url("https://www.smsgateway.center/library/api/self/Templates/")
  .post(body)
  .addHeader("content-type", "application/x-www-form-urlencoded")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.smsgateway.center/library/api/self/Templates/?userId=YourUsername&password=YourCurrentPassword&do=add&messageContent=Your%20verification%20code%20is%24__123__%24&format=json")
  .get()
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

Response

{
	"status":"success",
	"statusCode":"900",
	"transactionId":"1947554544086481",
	"reason":"Your Template has been successfully added and awaiting for moderation.."
}
<successResponse>
	<reason>Your Template has been successfully added and awaiting for moderation.</reason>
	<status>success</status>
	<statusCode>900</statusCode>
	<transactionId>8011123754916801</transactionId>
</successResponse>
status=success | transactionId=6222000214302529 | statusCode=900 | reason=Your Template has been successfully added and awaiting for moderation.