getTemplateStructure
    • PDF

    getTemplateStructure

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    GET/template

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    isUseBooleanOptional使用中のテンプレートとカテゴリ構造のみを照会するかどうか
    • 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}'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    contentsTemplateStructureResponseOptional照会対象テンプレートとカテゴリの詳細構造

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

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

    HTTPステータスコードコード説明
    200-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

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

    {
      "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
            }
          ]
        }
      ]
    }
    

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

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.