Status API

Customers can use the Status API to check the status of the message. It is a generic API that can return up to five last statuses of the message. After remediating and reclassifying the message using the Move API, users can check the status of the message using this API after some time.

Americas API endpoint:

https://api.us.etd.cisco.com/v1/messages/status 

Europe API endpoint:

https://api.de.etd.cisco.com/v1/messages/status

Australia API endpoint:

https://api.au.etd.cisco.com/v1/messages/status

India API endpoint:

https://api.in.etd.cisco.com/v1/messages/status

UAE API endpoint:

https://api.ae.etd.cisco.com/v1/messages/status

Sample Status API request using CURL:

  curl --location --request POST 'https://api.in.etd.cisco.com/v1/messages/status' \
--header 'x-api-key: apikeyTest’ \  
--header 'Authorization: Bearer <Bearer Token>' \
--header 'Content-Type: application/json' \
--data-raw '{"id":"c99f1f30-89ea-4306-bc44-1f9475ffaa1a"}' 

Sample Response:

{
    "data": {
        "actions": [
            {
                "timestamp": "2023-10-20T05:36:35.61606439Z",
                "action": "move",
                "folder": "inbox",
                "initiator": "api",
                "status": "succeeded",
                "publicApiClientId": "0487b580-801f-418c-b40f-9cb9cd023071"
            },
            {
                "timestamp": "2023-10-20T05:35:45.44136178Z",
                "action": "move",
                "folder": "quarantine",
                "userId": "e90a35aa-8db0-4ac4-9e5c-a13373902878",
                "initiator": "manual",
                "status": "succeeded"
            },
            {
                "timestamp": "2023-10-20T05:34:53.093442228Z",
                "action": "move",
                "folder": "trash",
                "initiator": "api",
                "status": "succeeded",
                "publicApiClientId": "0487b580-801f-418c-b40f-9cb9cd023071"
            }
        ],
        "verdicts": [
            {
                "timestamp": "2023-10-20T05:36:07Z",
                "verdict": "spam",
                "reclassifiedBy": "api",
                "publicApiClientId": "0487b580-801f-418c-b40f-9cb9cd023071"
            },
            {
                "timestamp": "2023-10-20T05:35:44.80385058Z",
                "verdict": "phishing",
                "reclassifiedBy": "user",
                "userId": "e90a35aa-8db0-4ac4-9e5c-a13373902878"
            }
        ],
        "id": "cbfeefa7-f738-4bdd-999a-3993ad92caa9"
    }
}

Note:

  1. Users can only pass one emailId in the request body.
  2. If the user remediated a message using the Move API, the initiator field value in the response would be "api".
  3. If the user reclassified a message using the Move API, the reclassifiedBy field value in the response would be "api" and the publicApiClientId would indicate which id performed the action.