getAddressBook
    • PDF

    getAddressBook

    • PDF

    기사 요약

    주소록 현황 조회 (총 주소 개수 및 각 수신자 그룹별 주소 개수 조회)

    GET https://mail.apigw.fin-ntruss.com/api/v1/address-book
    

    응답

    HTTP 상태코드설명
    200성공
    400인증 실패, 잘못된 요청
    500서버 에러

    예시

    요청 예시

    GET https://mail.apigw.fin-ntruss.com/api/v1/address-book
    

    응답 예시

    {
      "totalAddressCount": 4300,
      "groups": [
        {
          "sid": 155,
          "groupName": "10대",
          "addressCount": 3900
        },
        {
          "sid": 159,
          "groupName": "남자",
          "addressCount": 1000
        }
    }
    

    속성

    항목필수 여부타입제약사항설명
    totalAddressCountYesInteger총 메일주소 개수
    groupsNoList<AddressBookResponse>수신자 그룹 목록

    에러 코드

    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.