createAddressBook
    • PDF

    createAddressBook

    • PDF

    Article Summary

    受信者アドレス/グループを一括入力してもらい、アドレス帳を作成するようにリクエストします。
    レスポンスのメッセージは作成リクエスト直前のアドレス帳の現状で、作成作業は非同期で処理されます。
    update or insert方式でアドレス帳を変更(従来存在していた受信者グループには従来のアドレスに新しいアドレスを登録、存在しない受信者グループは新規で作成)し、作成作業が完了したらコンソールの右上にあるNotificationからご案内します。

    POST https://{endpoint}/address-book
    

    リクエストパラメータ

    パラメータ名必須タイプ制約事項説明
    groupsYesList<AddressBookRequest>受信者のEメールアドレスを含む受信者リスト

    レスポンス

    HTTPステータスコード説明
    201アドレス帳作成のリクエストが成功
    400認証失敗、間違ったリクエスト
    500サーバエラー

    例示

    リクエスト

    POST https://mail.apigw.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.