get_message_transmissions

URL: https://api.postageapp.com/v.1.0/get_message_transmissions.json

To get data on individual recipients' delivery and open status, you can pass a particular message UID and receive a JSON encoded set of data for each recipient within that message.

Pass the following - the UID is either the parameter you passed with the message API call, or if not sent, the UID returned on success:

{
  "api_key" : "PROJECT_API_KEY",
  "uid" : "uid_of_the_message"
 }

On success, the following data is returned (sample data included):

{
    "response": {
        "status": "ok",
        "uid": "uid_of_the_message"
    },
    "data": {
        "message": {
            "id": id_of_the_message
        },
        "transmissions": {
            "test@example.org": {
                "status": "completed",
                "created_at": "2012-07-04 18:58:57",
                "failed_at": null,
                "opened_at": "2012-07-04 19:59:22",
                "result_code": "SMTP_250",
                "result_message": "2.0.0 OK 123456789 abc123"
            },
            "sample@example.com": {
                "status": "retry",
                "created_at": "2012-07-04 18:58:57",
                "failed_at": null,
                "opened_at": null,
                "result_code": null,
                "result_message": null
            },
            "bad@example.org": {
                "status": "failed",
                "created_at": "2012-07-04 18:58:57",
                "failed_at": "2012-07-04 18:58:59",
                "opened_at": null,
                "result_code": "SMTP_554",
                "result_message": "User does not exist"
            }
        }
    }
}

Messages may be retried for up to 24 hours. Beyond this point only the opened_at parameter is liable to update.

Response time is proportional to the number of recipients on a given message.

If polling this endpoint, we recommend syncing at most hourly. If you have specific requirements beyond this, please email info@postageapp.com