リクエスト

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

メソッド	URI
POST	/files

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`fileList`	File	Required	アップロード対象のファイル

リクエスト例

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

curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/files'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--form 'fileList=@"/E:/desktop/test.txt"'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`tempRequestId`	String	Required	ファイルアップロード時に作成された仮のリクエスト ID ファイルを照会したり、削除する時に使用可能
`files`	List<AttachFile>	Required	アップロード対象のファイルリストメール添付時のファイルサイズは10MB以下にすること

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

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

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

レスポンス例

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

{
  "tempRequestId":"f355aac1-7776-4c0b-8484-20eaa065cb65-99",
  "files":[
    {
      "fileName":"test.txt",
      "fileSize":16,
      "fileId":"40fe58bd-91fe-4f89-a62e-705a7c17d65e-99"
    }
  ]
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud Outbound Mailer