getSendBlockList
- Print
- PDF
getSendBlockList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Get shipping block history
GET https://{endpoint}/send-block
Request
Request Parameters
| Parameter | Required | Type | Limitation | Description |
|---|---|---|---|---|
| size | No | Integer | Default:10 | Number of records per page. |
| page | No | Integer | Default:0 | Index of a page to receive results (0..N). |
| sort | No | String | Default: createUtc, createUtc: Creation time | Sort by (format: property(,asc|desc)): Messages are sorted in ascending order (asc) by default; multiple fields can be used for sorting. |
| targetAddress | Yes | String | email 주소 형식 | 발송 차단 내역을 확인할 메일 주소 |
Response
| HTTP status code | Description |
|---|---|
| 200 | Block History Lookup Completed |
| 400 | Authentication failed, invalid request. |
| 500 | Server error |
Example
Request Example
GET https://mail.apigw.ntruss.com/api/v1/send-block?targetAddress=test01%40ncp-mail.com
Response Example
{
"content": [
{
"targetAddress": "test01@ncp-mail.com",
"actionType": {
"label": "Delete",
"code": "D"
},
"actionRequesterType": {
"label": "System",
"code": "SYSTEM"
},
"requestDate": {
"utc": 1588649460935,
"formattedDate": "2020-05-05",
"formattedDateTime": "2020-05-05 12:31:00 935"
}
},
{
"targetAddress": "test01@ncp-mail.com",
"actionType": {
"label": "Create",
"code": "C"
},
"actionRequesterType": {
"label": "Other customer",
"code": "OTHER_CUSTOMER"
},
"requestDate": {
"utc": 1588044631372,
"formattedDate": "2020-04-28",
"formattedDateTime": "2020-04-28 12:30:31 372"
}
}
],
"registerStatus": "Not blocked",
"expectedDeleteDate": null,
"totalElements": 2,
"totalPages": 1,
"last": true,
"numberOfElements": 2,
"first": true,
"sort": [
{
"direction": "DESC",
"property": "createUtc",
"ignoreCase": false,
"nullHandling": "NATIVE",
"descending": true,
"ascending": false
}
],
"size": 10,
"number": 0
}
Properties
| Property | Required | Type | Limitation | Description |
|---|---|---|---|---|
| totalElements | Yes | Integer | Total number of records | |
| totalPages | Yes | Integer | Total number of pages | |
| numberOfElements | Yes | Integer | Number of records in the current page | |
| first | Yes | Boolean | Indicates whether it is the first page | |
| last | Yes | Boolean | Indicates whether it is the last page | |
| number | Yes | Integer | Index of the current page (starting from 0) | |
| size | Yes | Integer | Number of records per page | |
| sort | Yes | List<Sort> | Sort | |
| registerStatus | Yes | String | status : Blocking, Not blocked | Whether this mail is currently blocked from being sent |
| expectedDeleteDate | No | NesDateTime | Estimated time to unblock | |
| content | No | List<SendBlockHistoryResponse> | Content |
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 permissions |
| 403 | 77202 | No subscription |
| 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?