Sidebar Menu

GetUnreadIncomingMessages

This method returns all unread text message responses for a given license key and marks them as read. This method is deprecated: use ReadIncomingMessages instead.

Endpoint

GET:
https://messaging.esendex.us/messaging.svc/GetUnreadIncomingMessages?LicenseKey={LICENSEKEY}

POST:
https://messaging.esendex.us/messaging.svc/GetUnreadIncomingMessages

Syntax

GetUnreadIncomingMessages(LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
LicenseKey

Your license key.

String True 00000000-0000-0000-0000-000000000000

Response

Returns: SMSIncomingMessage object

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

// https://messaging.esendex.us/Messaging.svc?wsdl was added as a Service Reference and given the name WSDL

using WSDL;

var client = new MessagingClient(MessagingClient.EndpointConfiguration.mms2wsHttpBindingSecure);
var messages = await client.GetUnreadIncomingMessagesAsync(YOUR_LICENSE_KEY);

foreach (var m in messages)
{
    Console.WriteLine(
        "Incoming Message ID: " + m.IncomingMessageID + Environment.NewLine +
        "Matched Message ID: " + m.MatchedMessageID + Environment.NewLine +
        "To: " + m.ToPhoneNumber + Environment.NewLine +
        "From: " + m.FromPhoneNumber + Environment.NewLine +
        "UTC Time Received: " + m.ResponseReceiveDate + Environment.NewLine +
        "Message Text: " + m.Message + Environment.NewLine);
}
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
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 GetUnreadIncomingMessages{
    public static void main(String[] args) {
        try {
            URL url = new URL("https://messaging.esendex.us/Messaging.svc/GetUnreadIncomingMessages?"
                            + "LicenseKey=YOUR LICENSE KEY");

            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) {
        }
    }
}
<?php

$client = new SoapClient('https://messaging.esendex.us/Messaging.svc?wsdl');
$param = array('LicenseKey' => '(your license key)');
$result = $client->GetUnreadIncomingMessages($param);
print_r($result);

?>
<?php

$url = 'https://messaging.esendex.us/Messaging.svc/GetUnreadIncomingMessages?LicenseKey=(License Key)';
$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);

?>
"1627aea5-8e0a-4371-9022-9b504344e724"
[
	{
		"FromPhoneNumber": "String content",
		"IncomingMessageID": "1627aea5-8e0a-4371-9022-9b504344e724",
		"MatchedMessageID": "1627aea5-8e0a-4371-9022-9b504344e724",
		"Message": "String content",
		"ResponseReceiveDate": "\/Date(928164000000-0400)\/",
		"ToPhoneNumber": "String content"
	}
]
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1627aea5-8e0a-4371-9022-9b504344e724</guid>
<ArrayOfSMSIncomingMessage xmlns="http://sms2.cdyne.com">
  <SMSIncomingMessage>
    <FromPhoneNumber>String content</FromPhoneNumber>
    <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
    <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
    <Message>String content</Message>
    <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
    <ToPhoneNumber>String content</ToPhoneNumber>
  </SMSIncomingMessage>
  <SMSIncomingMessage>
    <FromPhoneNumber>String content</FromPhoneNumber>
    <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
    <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
    <Message>String content</Message>
    <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
    <ToPhoneNumber>String content</ToPhoneNumber>
  </SMSIncomingMessage>
</ArrayOfSMSIncomingMessage>