getSendBlockList
    • PDF

    getSendBlockList

    • PDF

    Article Summary

    발송 차단 내역 조회

    GET https://{endpoint}/send-block
    

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    sizeNoIntegerDefault:10페이지당 레코드 개수
    pageNoIntegerDefault:0결과를 받고 싶은 페이지 index (0..N)
    sortNoStringDefault: createUtc, createUtc: 생성 일시정렬기준 필드 (형식 : property(,asc|desc)) : 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용할 수 있다.
    targetAddressYesStringemail 주소 형식발송 차단 내역을 확인할 메일 주소
    ## 응답
    HTTP 상태코드설명
    200차단 내역 조회 완료
    400인증 실패, 잘못된 요청
    500서버 오류

    예시

    요청 예시

    GET https://mail.apigw.ntruss.com/api/v1/send-block?targetAddress=test01%40ncp-mail.com
    
    

    응답 예시

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

    속성

    항목필수 여부타입제약 사항설명
    totalElementsYesInteger총 레코드 개수
    totalPagesYesInteger총 페이지 개수
    numberOfElementsYesInteger현재 페이지의 레코드 개수
    firstYesBoolean첫 번째 페이지 여부
    lastYesBoolean마지막 페이지 여부
    numberYesInteger현재 페이지 index (0부터 시작)
    sizeYesInteger페이지당 레코드 개수
    sortYesList<Sort>정렬
    registerStatusYesString상태 : 차단 되지 않음, 차단 중현재 해당 메일이 발송 차단 중인지 여부
    expectedDeleteDateNoNesDateTime차단 해제 예정 일시
    contentNoList<SendBlockHistoryResponse>상세내용

    오류 코드

    HTTP Status Code리턴 코드응답 메시지
    40077101로그인 정보 오류
    40077102BAD_REQUEST
    40077103리소스가 존재하지 않음
    40377201권한 없음
    40377202Email 상품 사용신청 하지 않음
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301기본 프로젝트가 존재하지 않음
    50077302외부 시스템 API 연동 오류
    50077303그외 INTERNAL_SERVER_ERROR

    이 문서가 도움이 되었습니까?

    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.