getTemplateStructure

Prev Next

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

メールテンプレートとカテゴリ構造を照会します。

リクエスト

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

メソッド URI
GET /template

リクエストヘッダ

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

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
isUse Boolean Optional 使用中のテンプレートとカテゴリ構造のみを照会するかどうか
  • true | false
    • true: 使用中のテンプレートとカテゴリのみ照会
    • false: 使用していないテンプレートとカテゴリも一緒に照会

リクエスト例

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

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/template
?isUse=true' 
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
contents TemplateStructureResponse 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 その他の内部サーバエラー

レスポンス例

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

{
  "contents": [
    {
      "sid": 261,
      "parentSid": -1,
      "createDate": {
        "utc": 1589355820663,
        "formattedDate": "2020-05-13",
        "formattedDateTime": "2020-05-13 16:43:40 663"
      },
      "name": "AD",
      "isCategory": true,
      "isUse": true,
      "subCategories": null,
      "templates": [
        {
          "sid": 262,
          "parentSid": 261,
          "createDate": {
            "utc": 1589355868201,
            "formattedDate": "2020-05-13",
            "formattedDateTime": "2020-05-13 16:44:28 201"
          },
          "name": "AD_Template",
          "isCategory": false,
          "isUse": true,
          "subCategories": null,
          "templates": null
        }
      ]
    }
  ]
}