createAddressBook
- 印刷する
- PDF
createAddressBook
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
受信者アドレス/グループを一括入力してもらい、アドレス帳を作成するようにリクエストします。
レスポンスのメッセージは作成リクエスト直前のアドレス帳の現状で、作成作業は非同期で処理されます。
update or insert方式でアドレス帳を変更(従来存在していた受信者グループには従来のアドレスに新しいアドレスを登録、存在しない受信者グループは新規で作成)し、作成作業が完了したらコンソールの右上にあるNotificationからご案内します。
POST https://{endpoint}/address-book
リクエストパラメータ
パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
groups | Yes | List<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
}
}
属性
項目 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
totalAddressCount | Yes | Integer | メールアドレスの合計 | |
groups | No | List<AddressBookResponse> | 受信者グループのリスト |
エラーコード
HTTP Status Code | リターンコード | レスポンスのメッセージ |
---|---|---|
400 | 77101 | ログイン情報のエラー |
400 | 77102 | BAD_REQUEST |
400 | 77103 | リソースが存在しない |
403 | 77201 | 権限なし |
403 | 77202 | Email商品の利用申込をしていない |
405 | 77001 | METHOD_NOT_ALLOWED |
415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
500 | 77301 | 基本プロジェクトが存在しない |
500 | 77302 | 外部システムAPIの連動エラー |
500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?