建立範本

              
              POST /v1/template-configs  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "template_id": "test-template-1",       // 自訂的範本id，應用內唯一
    "description": "測試範本1",                 // 該範本的描述說明
    "send_channel_strategy": "whatsapp|sms",    // 範本的下發策略，支援whatsapp/sms/voice/email四類，組合策略則使用｜字元表示失敗補發
    "brand_name": "品牌名稱",                   // 品牌名稱，用在一些國家地區範本內容中的簽名（如簡訊管道中一些國家地區要求要註冊簽名）
    "verify_code_config": {                     // 驗證碼的配置，用於配置自動生成的驗證碼，範本包含驗證碼類型時必填
        "verify_code_type": 1,                  // 驗證碼類型，取值範圍[1,7]
        "verify_code_len": 6,                   // 驗證碼長度，取值範圍[4,10]
        "verify_code_ttl": 1                    // 驗證碼有效期，取值範圍[1,10]，注意當策略包含whatsapp時取值只能是1，5，10
    },
    "whatsapp_config": {                        // whatsapp策略的配置，當下發策略包含whatsapp時有效
        "template_type": 1,                      // whatsapp範本類型，目前僅支援預設範本，即固定取值為1
        "template_default_config": {            // whatsapp預設範本配置，針對預設範本類型時有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加過期時間內容
        }
    },
    "sms_config": {                             // sms策略的配置，當下發策略包含sms時有效
        "template_type": 2,                     // sms範本類型，取值：1-預設範本/2-自訂範本
        "template_default_config": {            // sms預設範本配置，針對預設範本類型時有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加過期時間內容
        },
        "template_custom_config": {             // sms自訂範本配置，sms範本類型為自訂範本時有效
            "custom_sub_type": "authentication",    // 自訂範本類型，取值：authentication-驗證碼/marketing-行銷/utility-通知
            "custom_content": "xxx",                // 自訂範本內容，注意若子類型為authentication驗證碼類型時必須包含{{code}}變數
            "custom_country_codes": "HK,PH"         // 自訂範本的目標國家地區，用於範本審核時參考，請按實際填寫，否則可能影響實際下發
        }
    },
    "voice_config": {                           // voice策略的配置，當下發策略包含voice時有效
        "template_type": 1,                      // voice範本類型，目前僅支援預設範本，即固定取值為1
        "template_default_config": {            // voice預設範本配置，針對預設範本類型時有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加過期時間內容
        }
    },
    "email_config": {                           // email策略的配置，當下發策略包含email時有效
        "template_name": "email範本名稱",                     // email範本名稱
        "template_custom_configs": [{           // email自訂範本配置，注意這裡是物件陣列，主要是透過language進行區分配置多個
            "language": "default",              // 語言，default為預設，訊息下發時可以根據language參數來匹配不同的範本內容
            "pre_from_name": "test",            // 預設的發件人名稱
            "pre_from_mail": "test@test.com",   // 預設的發件人信箱
            "pre_subject": "test",              // 預設的郵件主旨
            "template_content": "預設郵件範本內容，必填，自訂變數如{{self}},驗證碼是{{code}}",    // 郵件內容，支援html，變數需要使用兩個大括號{{}}括起來
            "pre_param_map": {                  // 郵件內容中變數的預設值，即下發時若不指定變數值，則採用下述的預設值來替換變數，採用key-value對聲明，value需要使用字串
                "self": "這裡是self變數預設值"
            }
        }]
    },
    "pwa_config": {                             // pwa相關的配置，暫時可以不使用
        "pwa_platform": "xx",                   // 使用的pwa平台，具體取值請與技術支援聯繫獲取確定
        "pwa_code": "xx"                        // 使用的pwa平台中的code
    }
}

            

              
              {
    "code": 0,
    "message": "success"
}

            

              
              {
    "code": 3003,
    "message": "not contains any channel config"
}

            

              
              {{brand_name}} 驗證碼

            

              
              <img src="{{logo_url}}" />
<strong>{{title}}</strong>
<p>您的驗證碼是 <strong>{{code}}</strong>，請在 {{ttl}} 分鐘內完成驗證。</p>
<p>如有疑問，請聯繫 <a href="mailto:{{support_email}}">{{support_email}}</a></p>

            

              
              "pre_param_map": {
  "logo_url": "https://example.com/logo.png",
  "title": "您的驗證碼",
  "support_email": "support@example.com"
}

            

              
              {
  "to": "user@example.com",
  "template": {
    "id": "my_email_template",
    "language": "default",
    "params": {
      "logo_url": "https://example.com/logo.png",
      "title": "您的驗證碼",
      "support_email": "support@example.com"
    }
  }
}