GetScreenshotStatus

Get the status of screenshot client sends. You can use this to determine if your email cannot be processed due to a client rejecting your content.

URLs:

Sandbox:

https://sandbox.emailonacid.com/v4/getScreenshotStatus - Default (XML) Request
https://sandbox.emailonacid.com/v4/getScreenshotStatus/xml - XML Request
https://sandbox.emailonacid.com/v4/getScreenshotStatus/json - JSON Request

Production:

https://api.emailonacid.com/v4/getScreenshotStatus - Default (XML) Request
https://api.emailonacid.com/v4/getScreenshotStatus/xml - XML Request
https://api.emailonacid.com/v4/getScreenshotStatus/json - JSON Request

Request:

XML

<?xml version="1.0" encoding="utf-8"?>
<get_screenshot_status>
    <eoa_test_id>UNIQUE EMAIL TEST ID</eoa_test_id>
</get_screenshot_status>

JSON

{
    "eoa_test_id": UNIQUE EMAIL TEST ID
}

JSON Validation Schema:

Click here to download.

Request Details

Element Description Data Type Required
eoa_test_id The reference id for the test to retrieve Integer Y

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <status>
        <client_status>
            <client>
                <client_code>1</client_code>
                <bounced>FALSE</bounced>
                <status_code>250</status_code>
                <message>OK</message>
            </client>
            <client>
                <client_code>15_1_8</client_code>
                <bounced>TRUE</bounced>
                <status_code>5.2.1</status_code>
                <message>AOL will not accept delivery of this message.</message>
            </client>
            <client>
                <client_code>15_1_4</client_code>
                <bounced>FALSE</bounced>
                <status_code>NULL</status_code>
                <message>NULL</message>
            </client>
            ....
        </client_status>
    </status>
</xml>

JSON

{
  "status": {
    "client_status": [
      {
        "client": {
          "client_code": "1",
          "bounced": "FALSE",
          "status_code": "250",
          "message": "OK"
        }
      },
      {
        "client": {
          "client_code": "15_1_8",
          "bounced": "TRUE",
          "status_code": "5.2.1",
          "message": "AOL will not accept delivery of this message."
        }
      },
      {
        "client": {
          "client_code": "15_1_4",
          "bounced": "FALSE",
          "status_code": "NULL",
          "message": "NULL"
        }
      },
      ....
}

Response Details

Element Description
client_code The id of the email client.
bounced If this email has bounced this will be set to TRUE, otherwise it will be FALSE.
status_code If the delivery of the email has been confirmed this will be 250. If the client has not yet replied, this will be NULL. If the client bounced the message, it will be the contents of the Status header from the client server. This value varies by client - you should check with the Postmaster at the client for details on the meaning of this code.
message If the delivery of the email has been confirmed this will be OK. If the client has not yet replied, this will be NULL. If the client bounced the message, it will be the contents of the Diagnostic-Code header from the client server. This value varies by client - you should check with the Postmaster at the client for details on the meaning of this message.