createConfig

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

メール送信プロジェクトごとに設定項目を作成します。現在は送信遮断機能のみ設定できます。

リクエスト

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

メソッド	URI
POST	/config

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`type`	String	Required	作成したり変更したりする設定項目 `SEND_BLOCK_TIME`: 送信遮断設定
`subType`	String	Optional	設定のサブタイプ `SEND_BLOCK_TIME`は`null`を入力
`value`	String	Required	作成したり変更したりする設定値 `type`、`subType`、`unit`に応じて値が決定 `SEND_BLOCK_TIME`は整数型文字列のみ可能で、7日または168時間以上に設定
`unit`	String	Required	設定値の単位 `DAY` \| `HOUR`

リクエスト例

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

curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/config'
--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 '{
  "type": "SEND_BLOCK_TIME",
  "value": "180",
  "unit" : "HOUR"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`type`	String	Required	作成されたり変更された設定項目
`subType`	Integer	Optional	設定のサブタイプ
`value`	String	Required	反映された設定値

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

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

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	その他の内部サーバエラー

レスポンス例

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

{
  "type": "SEND_BLOCK_TIME",
  "subType": null,
  "value": "180"
}