getTemplate

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

保存されているメールテンプレートを照会します。

リクエスト

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

メソッド	URI
GET	/template/{templateSid}

リクエストヘッダ

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

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

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`templateSid`	Integer	Required	照会するテンプレートの SID getTemplateStructureを参照

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`sid`	Integer	-	作成したテンプレートの SID
`createDate`	Object	-	作成日時 NesDateTimeを参照
`name`	String	-	作成したテンプレートの名前
`description`	String	-	作成したテンプレートの説明
`title`	String	-	メールの件名
`senderAddress`	String	-	送信者のメールアドレス
`senderName`	String	-	送信者名
`body`	String	-	メールの本文
`isUse`	Boolean	-	テンプレートの使用有無
`category`	Object	-	親カテゴリの情報 Categoryを参照

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

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "sid": 258,
  "createDate": {
    "utc": 1589348863431,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:47:43 431"
  },
  "name": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "body": "Congratulations on your membership.",
  "isUse": true,
  "category": {
    "sid": 252,
    "parentSid": -1,
    "name": "testCategory"
  }
}