Cancel Scheduled SMS Bulk SMS API Documentation

Cancel Scheduled SMS

You can cancel the scheduled SMS for a specific transaction ID.

You can fetch all scheduled SMS transaction ids using our API. Cancellation is done only basis on transaction IDs.

Application API URL:

https://www.smsgateway.center/SMSApi/rest/cancelScheduled

 

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
transactionId Transcation ID Provide the transaction ID to cancel the scheduled SMS.
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.

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/SMSApi/rest/cancelScheduled",
  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=YourPassword&format=json&transactionId=de2de966-3bb6-413d-b6f8-c563d6a88116",
  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/SMSApi/rest/cancelScheduled?userId=YourUsername&password=YourPassword&format=json&transactionId=de2de966-3bb6-413d-b6f8-c563d6a88116",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  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;
}
var qs = require("querystring");
var http = require("http");

var options = {
  "method": "POST",
  "hostname": "www.smsgateway.center",
  "port": null,
  "path": "/SMSApi/rest/cancelScheduled",
  "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: 'YourPassword',
  format: 'json',
  transactionId: 'de2de966-3bb6-413d-b6f8-c563d6a88116' }));
req.end();
var qs = require("querystring");
var http = require("http");

var options = {
  "method": "GET",
  "hostname": "www.smsgateway.center",
  "port": null,
  "path": "/SMSApi/rest/cancelScheduled?userId=YourUsername&password=YourPassword&format=json&transactionId=de2de966-3bb6-413d-b6f8-c563d6a88116",
  "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({}));
req.end();
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "userId=YourUsername&password=YourPassword&format=json&transactionId=de2de966-3bb6-413d-b6f8-c563d6a88116");
Request request = new Request.Builder()
  .url("https://www.smsgateway.center/SMSApi/rest/cancelScheduled")
  .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/SMSApi/rest/cancelScheduled?userId=YourUsername&password=YourPassword&format=json&transactionId=de2de966-3bb6-413d-b6f8-c563d6a88116")
  .get()
  .addHeader("content-type", "application/x-www-form-urlencoded")
  .addHeader("cache-control", "no-cache")
  .build();

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

Response

{
    "status": "success",
    "cancelledTransactionId": "a749de6a-4a0c-46a8-9035-c094a8a1a5e7",
    "transactionId": "155d40e3-eef7-4baf-a42e-96548fa821da",
    "statusCode": "900",
    "reason": "success"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cancelCauseIdSuccessResponse>
    <cancelledTransactionId>de2de966-3bb6-413d-b6f8-c563d6a88116</cancelledTransactionId>
    <reason>success</reason>
    <status>success</status>
    <statusCode>900</statusCode>
    <transactionId>fe63da6d-fa04-4880-b167-3b280e502a97</transactionId>
</cancelCauseIdSuccessResponse>
status=success | transactionId=5147317e-c6c7-4c64-a1d0-f355e69f419c | statusCode=900 | reason=success