MENU
      getMailRequestStatus

        getMailRequestStatus


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        requestIdStringRequiredEmail 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}'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        requestIdStringRequiredEmail delivery request ID to distinguish each request
        • requestId can contain multiple mailId when requesting multiple mailings at once
        readyCompletedBooleanRequiredWhether 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
        allSentSuccessBooleanRequiredWhether all requested emails were sent successfully
        • true | false
          • true: success
          • false: failure
        requestCountIntegerRequiredNumber of delivery requests
        sentCountIntegerRequiredNumber of successful deliveries
        finishCountIntegerRequiredNumber of emails processed
        • Including delivery successful, failure, rejected, and canceled
        readyCountIntegerRequiredNumber of emails ready or sent
        • Number of emails entered to the database for delivery
        reservationDateNesDateTimeOptionalReserved date and time
        countsByStatusList<CountByStatus>RequiredNumber of emails by status

        Response status codes

        The following describes the response status codes.

        HTTP status codeCodeDescription
        200-Request succeeded
        400-Authentication failed, invalid request
        40077101Error in login information
        40077102Request error
        40077103Requested resource does not exist
        40377201No permissions to the requested resource
        40377202Call from a user who hasn't subscribed to the email service
        40577001Unsupported method type
        41577002Unsupported media type
        500-Server error
        50077301Default project does not exist
        50077302External system API integration error
        50077303Other 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
            }
          ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.