MENU
      getSendBlockList

        getSendBlockList


        Article summary

        Available in Classic and VPC

        Get the default time at which the system automatically blocks sending for a specific recipient

        Request

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

        MethodURI
        GET/send-block

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        sizeIntegerOptionalNumber of records per page
        • 10 (default)
        pageIntegerOptionalPage index to view
        • 0 or greater
        sortStringOptionalSort by
        • createUtc (default)
          • createUtc: creation date and time
        • property (,asc|desc) format
          • asc (default)
        • Multiple sort criteria can be set
        targetAddressStringRequiredRecipient's email address to view the blocked delivery history for

        Request example

        The following is a sample request.

        curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/send-block
        ?targetAddress=test01%40ncp-mail.com'
        --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
        contentList<SendBlockHistoryResponse>OptionalDetails for the blocked delivery list
        registerStatusStringRequiredWhether the email is currently blocked from delivery
        expectedDeleteDateNesDateTimeRequiredDate and time of scheduled unblocking
        lastBooleanRequiredIt indicates whether this is the last page
        totalElementsIntegerRequiredTotal number of records
        totalPagesIntegerRequiredTotal number of pages
        firstBooleanRequiredIt indicates whether this is the first page
        numberOfElementsIntegerRequiredNumber of records in the current page
        sizeIntegerRequiredNumber of records per page
        numberIntegerRequiredIndex of the current page
        • 0 or greater
        sortList<Sort>RequiredSort by

        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.

        {
          "content": [
            {
              "targetAddress": "test01@ncp-mail.com",
              "actionType": {
                "label": "Delete",
                "code": "D"
              },
              "actionRequesterType": {
                "label": "System",
                "code": "SYSTEM"
              },
              "requestDate": {
                "utc": 1593076560930,
                "formattedDate": "2020-06-25",
                "formattedDateTime": "2020-06-25 18:16:00 930"
              },
              "historySid": 62633,
              "sendResultCode": null,
              "sendResultMessage": null
            },
            {
              "targetAddress": "test01@ncp-mail.com",
              "actionType": {
                "label": "Create",
                "code": "C"
              },
              "actionRequesterType": {
                "label": "Other customer",
                "code": "OTHER_CUSTOMER"
              },
              "requestDate": {
                "utc": 1592471705229,
                "formattedDate": "2020-06-18",
                "formattedDateTime": "2020-06-18 18:15:05 229"
              },
              "historySid": 62632,
              "sendResultCode": "RECIPIENT_ADDRESS_ERROR",
              "sendResultMessage": "550 5.1.1 <test01@ncp-mail.com>: Recipient address rejected: User unknown in local recipient table\n"
            }
          ],
          "registerStatus": "Not blocked",
          "expectedDeleteDate": null,
          "last": true,
          "totalElements": 8,
          "totalPages": 1,
          "first": true,
          "numberOfElements": 8,
          "size": 10,
          "number": 0,
          "sort": [
            {
              "direction": "DESC",
              "property": "createUtc",
              "ignoreCase": false,
              "nullHandling": "NATIVE",
              "ascending": false,
              "descending": true
            }
          ]
        }
        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.