リクエスト

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

メソッド	URI
DELETE	/address-book/recipient-groups/address

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`groupName`	String	Required	対象受信者グループの名前
`emailAddresses`	List<String>	Required	削除対象の受信者メールアドレスリスト

リクエスト例

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

curl --location --request DELETE 'https://mail.apigw.ntruss.com/api/v1/address-book/recipient-groups/address'
--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 '{
  "groupName":"10代",
  "emailAddresses":[
    "a@naver.com",
    "b@daum.net"
  ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalAddressCount`	Integer	Required	総メールアドレス数
`groups`	List<AddressBookResponse>	Optional	受信者グループ情報

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード	コード	説明
200	-	リクエスト成功
400	-	認証失敗、無効なリクエスト
400	77101	ログイン情報エラー
400	77102	リクエストエラー
400	77103	リクエストしたリソースが存在しない
403	77201	リクエストしたリソースに対する権限がない
403	77202	メールサービスの使用を申し込んでいないユーザーが呼び出した場合
405	77001	サポートしないメソッドタイプ
415	77002	サポートしないメディアタイプ
500	-	サーバエラー
500	77301	基本プロジェクトが存在しない
500	77302	外部システム API連携エラー
500	77303	その他の内部サーバエラー

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "totalAddressCount": 4300,
  "groups": [
    {
      "sid": 155,
      "groupName": "10代",
      "addressCount": 3900
    },
    {
      "sid": 159,
      "groupName": "男性",
      "addressCount": 1000
    }
}