Secure Message Center (SMC) API
API change historyGET UNREAD MESSAGE SUMMARIES
This method returns message summaries for all unread messages in the user's Inbox. A session key must be submitted via the X-Session-Key header. The request body should be left empty. Include "?After=" to specify the last message ID received to receive only messages created since the ID reference. A successful transaction will receive a 200 status code.
Try itRequest
Request URL
Request parameters
-
(optional)integer
Format - int32. Used to specify the last message ID received to receive summaries only for messages created since the ID reference
Request headers
-
(optional)string
Request body
Responses
200 OK
Ok
Representations
{
"Summaries": [
{
"AttachmentCount": 0,
"InlineAttachmentCount": 0,
"createTimeString": "string",
"FolderId": 0,
"MessageId": 0,
"MessageSize": 0,
"Read": true,
"MessageStatus": 0,
"SenderAddress": "string",
"Subject": "string",
"FirstRecipient": "string"
}
]
}{
"description": "Message summary collection data",
"required": [
"Summaries"
],
"type": "object",
"properties": {
"Summaries": {
"description": "A message summaries structure containing the message summary data for each message",
"type": "array",
"items": {
"description": "Message summary data",
"required": [
"AttachmentCount",
"InlineAttachmentCount",
"createTimeString",
"FolderId",
"MessageId",
"MessageSize",
"Read",
"MessageStatus",
"SenderAddress",
"Subject",
"FirstRecipient"
],
"type": "object",
"properties": {
"AttachmentCount": {
"format": "int32",
"description": "The number of attachments sent with the message",
"type": "integer"
},
"InlineAttachmentCount": {
"format": "int32",
"description": "The number of attachments sent with the message",
"type": "integer"
},
"createTimeString": {
"description": "Date/time the message was created",
"type": "string"
},
"FolderId": {
"format": "int32",
"description": "Unique folder identifier",
"type": "integer"
},
"MessageId": {
"format": "int32",
"description": "Unique message identifier",
"type": "integer"
},
"MessageSize": {
"format": "int64",
"description": "Size of message (bytes)",
"type": "integer"
},
"Read": {
"description": "Indicates whether or not the message was opened",
"type": "boolean"
},
"MessageStatus": {
"format": "int32",
"description": "Integer referring to status of message.\r\nSender-Only Status Types:\r\n[-8(DirectMessageFailed), -7(PendingUpload), -6(PendingLicense), -5(Pending), -4(Restricted), -3(Deleted), -2(Retracted), -1(Draft), 0(EditMode)]\r\nSender/Recipient Status Types:\r\n[1(NoticeInQueue), 2(NoticeSent)]\r\nPer Recipient (not per message) Status Types:\r\n[3(UnRead), 4(Read)]\r\nPush Status Types:\r\n[5(SentSafeTls), 6(NoticeError), 7(Pop3Delivered), 8(PushedZip), 10(PushedPdf)]\r\nSecureForms Status Types:\r\n[11(DistributionRequestProcessed), 12(DistributionRequestFailed)]\r\nDataBridge Status Types:\r\n[13(WorkflowDestinationEnroute), 14(WorkflowDestinationDelivered), 15(WorkflowDestinationUnreachable)]\r\nDataMotion Direct Status Types:\r\n[16(DirectMessageQueued), 17(DirectMessageSent), 18(DirectMessageDispatched), 19(DirectMessageProcessed)]",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
-8,
-7,
-6,
-5,
-4,
-3,
-2,
-1
],
"type": "integer"
},
"SenderAddress": {
"description": "Sender's email address",
"type": "string"
},
"Subject": {
"description": "Subject of the message",
"type": "string"
},
"FirstRecipient": {
"description": "First To recipient of the message",
"type": "string"
}
}
}
}
}
}401 Unauthorized
The X-Session-Key header is missing. || Bad session key. || Session key expired. || User is not authorized to use the Web Service API.
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread?after={integer}"
-H "X-Session-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("X-Session-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["after"] = "{integer}";
var uri = "https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread");
builder.setParameter("after", "{integer}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("X-Session-Key", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"after": "{integer}",
};
$.ajax({
url: "https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Session-Key","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread";
NSArray* array = @[
// Request parameters
@"entities=true",
@"after={integer}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Session-Key"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Session-Key' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'after' => '{integer}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'X-Session-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'after': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.datamotion.com')
conn.request("GET", "/SecureMail-Sandbox/Message/Inbox/Unread?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'X-Session-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'after': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.datamotion.com')
conn.request("GET", "/SecureMail-Sandbox/Message/Inbox/Unread?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.datamotion.com/SecureMail-Sandbox/Message/Inbox/Unread')
query = URI.encode_www_form({
# Request parameters
'after' => '{integer}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-Session-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body