getMailRequestStatus
  • PDF

getMailRequestStatus

  • PDF

Gets the delivery status and the number of emails, by status of the emails that are being sent, by specifying a requestId.

GET https://{endpoint}/mails/requests/{requestId}/status

Request

Request parameters

Parameter name Required status Type Restrictions Description
requestId Yes String Request ID to send an email (for identifying each request). If you make a request to send multiple messages at the same time, then the requestId can contain multiple mailIds.

Response

HTTP status code Description
200 Success
400 Authentication failed, invalid request.
500 Server errors

Example

Request example

GET https://mail.apigw.ntruss.com/api/v1/mails/requests/20181126000000246001/status

Response example

{
  "requestId":"20181126000000246001",
  "readyCompleted":true,
  "allSentSuccess":false,
  "requestCount":35179,
  "sentCount":33502,
  "finishCount":35179,
  "readyCount":35179,
  "reservationDate":null,
  "countsByStatus":[
    {
      "status":{
        "label":"Failed to send",
        "code":"F"
      },
      "count":1415
    },
    {
      "status":{
        "label":"Sent successfully",
        "code":"S"
      },
      "count":33502
    },
    {
      "status":{
        "label":"Unsubscribe",
        "code":"U"
      },
      "count":262
    }
  ]
}

Property

Category Required status Type Restrictions Description
requestId Yes String Request ID to send an email (for identifying each request). If you make a request to send multiple messages at the same time, then the requestId can contain multiple mailIds.
readyCompleted Yes Boolean Indicates whether messages are ready to be sent. - This indicates whether the emails requested to be sent are added to the DB and ready to be sent. (It is true, even when they are already sent.)
allSentSuccess Yes Boolean Indicates whether all the requested emails are successfully sent.
requestCount Yes Integer Number of emails requested to be sent.
sentCount Yes Integer Number of emails sent successfully.
finishCount Yes Integer Number of emails processed (sent successfully + failed + unsubscribed + canceled)
readyCount Yes Integer Number of emails that are ready or sent successfully (the number of emails added to the DB)
reservationDate No DateTime Scheduled date and time
countsByStatus Yes List<CountByStatus> Number of emails by status

Error codes

HTTP Status Code Return code Response message
400 77101 Error in login information
400 77102 BAD_REQUEST
400 77103 Resource not found
403 77201 No permission
403 77202 No request to subscribe the email product
405 77001 METHOD_NOT_ALLOWED
415 77002 UNSUPPORTED_MEDIA_TYPE
500 77301 Default project not found
500 77302 Error in working with external system API
500 77303 Other INTERNAL_SERVER_ERROR

Was this article helpful?

What's Next