Secure Message Center (SMC) API

API change history

GET YOUR ACCOUNT DETAILS

This method is used to query account information about the user. (like the password expiration date, or how many unread messages are in the user's inbox) based on the session key passed. A session key must be submitted via the X-Session-Key header. The request body should be left empty. A successful transaction will receive a 200 status code.

Try it

Request

Request URL

Request headers

  • (optional)
    string
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Ok

Representations

{
  "EmailAddress": "string",
  "FirstName": "string",
  "LastName": "string",
  "Statistics": {
    "AccountSize": 0,
    "AvailableAccountSize": 0,
    "DateCreated": "string",
    "DateOfLastNotice": "string",
    "DateOfLastVisit": "string",
    "DatePasswordExpires": "string",
    "TotalFilesInOutbox": 0,
    "TotalFilesSent": 0,
    "TotalMessagesInInbox": 0,
    "TotalMessagesInOutbox": 0,
    "TotalMessagesReceived": 0,
    "TotalMessagesSent": 0,
    "TotalUnreadMessagesInInbox": 0,
    "TotalVisits": 0,
    "UsedAccountSize": 0
  },
  "Uid": 0,
  "UserId": "string"
}
{
  "description": "The user account data",
  "required": [
    "EmailAddress",
    "FirstName",
    "LastName",
    "Statistics",
    "Uid",
    "UserId"
  ],
  "type": "object",
  "properties": {
    "EmailAddress": {
      "description": "The email address of the user",
      "type": "string"
    },
    "FirstName": {
      "description": "The first name of the user",
      "type": "string"
    },
    "LastName": {
      "description": "The last name of the user",
      "type": "string"
    },
    "Statistics": {
      "description": "A statistics structure containing user data",
      "required": [
        "AccountSize",
        "AvailableAccountSize",
        "DateCreated",
        "DateOfLastNotice",
        "DateOfLastVisit",
        "DatePasswordExpires",
        "TotalFilesInOutbox",
        "TotalFilesSent",
        "TotalMessagesInInbox",
        "TotalMessagesInOutbox",
        "TotalMessagesReceived",
        "TotalMessagesSent",
        "TotalUnreadMessagesInInbox",
        "TotalVisits",
        "UsedAccountSize"
      ],
      "type": "object",
      "properties": {
        "AccountSize": {
          "format": "int64",
          "description": "The total size of the user's account",
          "type": "integer"
        },
        "AvailableAccountSize": {
          "format": "int64",
          "description": "How much of the total account size is still available",
          "type": "integer"
        },
        "DateCreated": {
          "description": "Date created",
          "type": "string"
        },
        "DateOfLastNotice": {
          "description": "Date of last notice",
          "type": "string"
        },
        "DateOfLastVisit": {
          "description": "Date and time the user last logged into the account",
          "type": "string"
        },
        "DatePasswordExpires": {
          "description": "Date that the user's password will expire",
          "type": "string"
        },
        "TotalFilesInOutbox": {
          "format": "int32",
          "description": "Total number of files in the outbox",
          "type": "integer"
        },
        "TotalFilesSent": {
          "format": "int32",
          "description": "Total number of files sent",
          "type": "integer"
        },
        "TotalMessagesInInbox": {
          "format": "int32",
          "description": "Total number of messages in the Inbox",
          "type": "integer"
        },
        "TotalMessagesInOutbox": {
          "format": "int32",
          "description": "Total number of messages in the Outbox",
          "type": "integer"
        },
        "TotalMessagesReceived": {
          "format": "int32",
          "description": "Total number of messages received for the lifetime of the mailbox",
          "type": "integer"
        },
        "TotalMessagesSent": {
          "format": "int32",
          "description": "Total number of messages sent for the lifetime of the mailbox",
          "type": "integer"
        },
        "TotalUnreadMessagesInInbox": {
          "format": "int32",
          "description": "Total number of unread messages in the Inbox",
          "type": "integer"
        },
        "TotalVisits": {
          "format": "int32",
          "description": "Total number of times a mailbox was ever visited",
          "type": "integer"
        },
        "UsedAccountSize": {
          "format": "int64",
          "description": "Total disk space (kb) consumed by the user's Outbox",
          "type": "integer"
        }
      }
    },
    "Uid": {
      "format": "int32",
      "description": "The DataMotion UID of the user",
      "type": "integer"
    },
    "UserId": {
      "description": "The User ID of the user",
      "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/Account/Details"
-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}");

            var uri = "https://api.datamotion.com/SecureMail-Sandbox/Account/Details?" + 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/Account/Details");


            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
        };
      
        $.ajax({
            url: "https://api.datamotion.com/SecureMail-Sandbox/Account/Details?" + $.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/Account/Details";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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/Account/Details');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'X-Session-Key' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.datamotion.com')
    conn.request("GET", "/SecureMail-Sandbox/Account/Details?%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({
})

try:
    conn = http.client.HTTPSConnection('api.datamotion.com')
    conn.request("GET", "/SecureMail-Sandbox/Account/Details?%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/Account/Details')


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