Sidebar Menu

CancelMessage

This method uses the Message ID to cancel a message scheduled for a later time or date. Does not work if message was already sent out or queued.

Endpoint

GET (HTTP): https://sms2.cdyne.com/sms.svc/CancelMessage?MessageID={MESSAGEID}

Syntax

CancelMessage(MessageID)

Request Parameters

Parameter Name Description Data Type Required Sample Value
MessageID

Input unique Guid ID that is returned with every SMS message sent.

GUID True B01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: Boolean

Description: Whether the cancellation was successful or not.

Code Samples

using CancelMessage.WSDL;

namespace CancelMessage
{
    class Program
    {
        static void Main(string[] args)
        {
            IsmsClient client = new IsmsClient("sms2wsHttpBinding");
            bool resp = client.CancelMessage(new Guid("MESSAGE ID HERE"));
            bool Success = true;

            if (Success == true)
            {
                Console.WriteLine("Message successfully cancelled.");
            }

            Console.ReadLine();
            client.Close();
        }
    }
}
Imports CancelMessage.WSDL

Module Module1

    Sub Main()

        Dim client As New CancelMessage.WSDL.IsmsClient("sms2wsHttpBinding")
        Dim resp As Boolean = client.CancelMessage(New Guid("MESSAGE ID HERE"))
        Dim Success As Boolean = True

        If Success = True Then
            Console.WriteLine("Message successfully cancelled.")
        End If

        Console.ReadLine()
        client.Close()

    End Sub

End Module
Dim oXMLHTTP
Set oXMLHTTP = CreateObject("Microsoft.XMLHTTP")
Set oDoc = CreateObject("MSXML2.DOMDocument")

Call oXMLHttp.Open("GET", "http://sms2.cdyne.com/sms.svc/CancelMessage?MessageID=MESSAGE ID HERE", False)
Call oXMLHttp.setRequestHeader("Content-Type", "text/xml")
Call oXMLHttp.send

MsgBox oXMLHTTP.responseText
<?php

// Returns a 1 if the SMS is canceled and nothing if it is not cancelled.


$client = new SoapClient('http://sms2.cdyne.com/sms.svc?wsdl');

$param = array('MessageID' =>
  'Message ID' // MessageID from SMSResponse Object
);

$result = $client->CancelMessage($param);
print_r($result);

?>
<?php

$url = 'http://sms2.cdyne.com/sms.svc/CancelMessage?MessageID=(Message ID)';
$cURL = curl_init();

curl_setopt($cURL, CURLOPT_URL, $url);
curl_setopt($cURL, CURLOPT_HTTPGET, true);
curl_setopt($cURL, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));

$result = curl_exec($cURL);
curl_close($cURL);

print_r($result);

?>
require 'net/http'
require 'URI'

puts URI.methods
url = URI.parse('http://sms2.cdyne.com/sms.svc/CancelMessage?MessageID=MESSAGE ID HERE')
res = Net::HTTP.get_response(url)
data = res.body

puts data
gets data
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.URL;
import java.net.MalformedURLException;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

public final class CancelMessage {
    public static void main(String[] args) {
        try {
            URL url = new URL("http://sms2.cdyne.com/sms.svc/CancelMessage?"
                            + "MessageID=MESSAGEID OF MESSAGE YOU WANT TO CANCEL");

            try {
                InputStream in = url.openStream();
                StreamSource source = new StreamSource(in);
                printResult(source);
            } catch (java.io.IOException e) {
                e.printStackTrace();
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    private static void printResult(Source source) {
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            StreamResult sr = new StreamResult(bos);

            Transformer trans = TransformerFactory.newInstance().newTransformer();
            Properties oprops = new Properties();
            oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperties(oprops);
            trans.transform(source, sr);

            System.out.println("**** Response ******");
            System.out.println(bos.toString());

            bos.close();
            System.out.println();
        } catch (Exception e) {
        }
    }
}