createAddressBook
    • PDF

    createAddressBook

    • PDF

    기사 요약

    수신자 주소/그룹 일괄로 입력받아 주소록 생성을 요청합니다.

    응답 메시지는 생성 요청 직전의 주소록 현황 정보이며 생성 작업은 비동기로 처리됩니다.

    update or insert 방식으로 주소록 변경 합니다. (기존 존재하는 수신자 그룹에는 기존 주소에 새로운 주소 등록, 존재하지 않는 수신자 그룹은 신규 생성)

    POST https://mail.apigw.gov-ntruss.com/api/v1/address-book
    

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    groupsYesList<AddressBookRequest>수신자 이메일 주소를 포함한 수신자 그룹목록

    응답

    HTTP 상태코드설명
    201주소록 생성 요청 성공
    400인증 실패, 잘못된 요청
    500서버 오류

    예시

    요청 예시

    POST https://mail.apigw.gov-ntruss.com/api/v1/address-book
    
    {
      "groups":[
        {
          "groupName":"10대",
          "emailAddresses":[
            "xxx@naver.com",
            ...
          ]
        },
        {
          "groupName":"남자",
          "emailAddresses":[
            "xxx@daum.net",
            ...
          ]
        }
      ]
    }
    

    응답 예시

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

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

    What's Next
    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.