取得範本詳情
呼叫網址
GET https://otp.api.engagelab.cc/v1/template-configs/{templateId}
呼叫驗證
請參考 呼叫驗證 了解如何進行 API 驗證。
請求
請求參數
URL 中的 {templateId} 表示要取得的範本 ID,該範本 ID 由建立範本 API 時呼叫方自行定義的。
請求範例
請求標頭
GET /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
此代碼塊在浮窗中顯示
請求主體
無
回應
回應參數
返回範本詳細配置資訊的 JSON 物件。
回應範例
成功返回
{
"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
},
"sms_config": { // sms 策略的配置,當下發策略包含 sms 時返回
"template_type": 2, // sms 範本類型,取值:1-預設範本/2-自訂範本
"template_parts": 1, // sms 範本預估的計費條數,範本過長則會具體的價格=計費條數*計費單價
"template_custom_config": { // sms 自訂範本配置,sms 範本類型為自訂範本時有效
"custom_sub_type": "authentication", // 自訂範本類型,取值:authentication-驗證碼/marketing-行銷/utility-通知
"custom_content": "xxx" // 自訂範本內容,注意若子類型為 authentication 驗證碼類型時必須包含{{code}}變數
}
},
"voice_config": { // voice 策略的配置,當下發策略包含 voice 時返回
"template_type": 1 // voice 範本類型,目前僅支援預設範本,即固定取值為 1
},
"email_config": { // email 策略的配置,當下發策略包含 email 時返回
"template_name": "email範本名稱", // email 範本名稱
"template_custom_configs": [{ // email 自訂範本配置,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 對聲明
"self": "這裡是self變數預設值"
}
}]
},
"pwa_config": { // pwa 相關的配置,具有 pwa 配置時才會返回
"pwa_platform": "xx", // 使用的 pwa 平台
"pwa_code": "xx" // 使用的 pwa 平台中的 code
},
"created_time": 1234567890, // 該範本的建立時間,時間戳格式,精確到秒
"status": 1, // 範本狀態,取值:1-待審核/2-審核通過/3-審核拒絕
"audit_remark": "xx" // 審核備註,一般當審核拒絕時可以查看該欄位看審核拒絕說明
}
{
"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
},
"sms_config": { // sms 策略的配置,當下發策略包含 sms 時返回
"template_type": 2, // sms 範本類型,取值:1-預設範本/2-自訂範本
"template_parts": 1, // sms 範本預估的計費條數,範本過長則會具體的價格=計費條數*計費單價
"template_custom_config": { // sms 自訂範本配置,sms 範本類型為自訂範本時有效
"custom_sub_type": "authentication", // 自訂範本類型,取值:authentication-驗證碼/marketing-行銷/utility-通知
"custom_content": "xxx" // 自訂範本內容,注意若子類型為 authentication 驗證碼類型時必須包含{{code}}變數
}
},
"voice_config": { // voice 策略的配置,當下發策略包含 voice 時返回
"template_type": 1 // voice 範本類型,目前僅支援預設範本,即固定取值為 1
},
"email_config": { // email 策略的配置,當下發策略包含 email 時返回
"template_name": "email範本名稱", // email 範本名稱
"template_custom_configs": [{ // email 自訂範本配置,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 對聲明
"self": "這裡是self變數預設值"
}
}]
},
"pwa_config": { // pwa 相關的配置,具有 pwa 配置時才會返回
"pwa_platform": "xx", // 使用的 pwa 平台
"pwa_code": "xx" // 使用的 pwa 平台中的 code
},
"created_time": 1234567890, // 該範本的建立時間,時間戳格式,精確到秒
"status": 1, // 範本狀態,取值:1-待審核/2-審核通過/3-審核拒絕
"audit_remark": "xx" // 審核備註,一般當審核拒絕時可以查看該欄位看審核拒絕說明
}
此代碼塊在浮窗中顯示
失敗返回
{
"code": 4001,
"message": "config not exist"
}
{
"code": 4001,
"message": "config not exist"
}
此代碼塊在浮窗中顯示
錯誤碼
| 錯誤碼 | http code | 說明 |
|---|---|---|
| 1000 | 500 | 內部錯誤 |
| 2001 | 401 | 驗證失敗,未攜帶正確的 token |
| 2002 | 401 | 驗證失敗,token 已過期或已被停用 |
| 2004 | 403 | 無呼叫此 API 的權限 |
| 4001 | 400 | 範本不存在 |










