getMailRequestStatus

Available in Classic and VPC

Use the delivery request ID to see how the delivery request for a specific email was handled.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/mails/requests/{requestId}/status

Request headers

For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`requestId`	String	Required	Email delivery request ID to distinguish each request `requestId` can contain multiple `mailId` when requesting multiple mailings at once

Request example

The following is a sample request.

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/mails/requests/20181126000000246001/status'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`requestId`	String	Required	Email delivery request ID to distinguish each request `requestId` can contain multiple `mailId` when requesting multiple mailings at once
`readyCompleted`	Boolean	Required	Whether all requests have been entered into the database and are ready to be delivered `true` \| `false` `true`: delivery preparation completed (including delivery completion) `false`: delivery preparation not completed
`allSentSuccess`	Boolean	Required	Whether all requested emails were sent successfully `true` \| `false` `true`: success `false`: failure
`requestCount`	Integer	Required	Number of delivery requests
`sentCount`	Integer	Required	Number of successful deliveries
`finishCount`	Integer	Required	Number of emails processed Including delivery successful, failure, rejected, and canceled
`readyCount`	Integer	Required	Number of emails ready or sent Number of emails entered to the database for delivery
`reservationDate`	NesDateTime	Optional	Reserved date and time
`countsByStatus`	List<CountByStatus>	Required	Number of emails by status

Response status codes

The following describes the response status codes.

HTTP status code	Code	Description
200	-	Request succeeded
400	-	Authentication failed, invalid request
400	77101	Error in login information
400	77102	Request error
400	77103	Requested resource does not exist
403	77201	No permissions to the requested resource
403	77202	Call from a user who hasn't subscribed to the email service
405	77001	Unsupported method type
415	77002	Unsupported media type
500	-	Server error
500	77301	Default project does not exist
500	77302	External system API integration error
500	77303	Other internal server error

Response example

The following is a sample response.

{
  "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
    }
  ]
}