createAddressBook

Classic/VPC 환경에서 이용 가능합니다.

수신자 그룹과 주소를 입력하여 주소록을 생성합니다. 응답 메시지는 생성 요청 직전의 주소록 현황 정보이며 생성 작업은 비동기로 처리됩니다.
생성된 주소록을 변경할 수도 있습니다. 존재하는 수신자 그룹에 새 주소를 등록하거나 신규 수신자 그룹을 생성하는 방식으로 사용 가능합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://mail.apigw.gov-ntruss.com/api/v1/address-book' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "groups":[
    {
      "groupName":"10대",
      "emailAddresses":[
        "xxx@naver.com",
        ...
      ]
    },
    {
      "groupName":"남자",
      "emailAddresses":[
        "xxx@daum.net",
        ...
      ]
    }
  ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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