createAddressBook

Classic/VPC環境で利用できます。

受信者グループとアドレスを入力してアドレス帳を作成します。レスポンスメッセージは作成リクエスト直前のアドレス帳の状況情報であり、作成作業は非同期で処理されます。
作成されたアドレス帳を変更することもできます。既存の受信者グループに新しいアドレスを登録するか、新規受信者グループを作成することで使用可能です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://mail.apigw.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
    }
  ]
}