getSendBlockList
- Print
- PDF
getSendBlockList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
| Method | URI |
|---|---|
| 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.
| Field | Type | Required | Description |
|---|---|---|---|
size | Integer | Optional | Number of records per page
|
page | Integer | Optional | Page index to view
|
sort | String | Optional | Sort by
|
targetAddress | String | Required | Recipient'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}'
Response
The following describes the response format.
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
content | List<SendBlockHistoryResponse> | Optional | Details for the blocked delivery list |
registerStatus | String | Required | Whether the email is currently blocked from delivery |
expectedDeleteDate | NesDateTime | Required | Date and time of scheduled unblocking |
last | Boolean | Required | It indicates whether this is the last page |
totalElements | Integer | Required | Total number of records |
totalPages | Integer | Required | Total number of pages |
first | Boolean | Required | It indicates whether this is the first page |
numberOfElements | Integer | Required | Number of records in the current page |
size | Integer | Required | Number of records per page |
number | Integer | Required | Index of the current page
|
sort | List<Sort> | Required | Sort by |
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.
{
"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
}
]
}
Was this article helpful?