Logo Site EngageLab Mark Colored Transparent文件
搜尋

取得所有範本列表

目前該 API 不做分頁,將返回所有的範本列表簡要內容。主要減去了具體的內容,若需要得到內容請使用詳情 API。

呼叫網址

GET https://otp.api.engagelab.cc/v1/template-configs

呼叫驗證

請參考 呼叫驗證 了解如何進行 API 驗證。

請求

請求參數

請求範例

請求標頭

GET /v1/template-configs HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              GET /v1/template-configs  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 範本預估的計費條數,範本過長則會具體的價格=計費條數*計費單價 }, "voice_config": { // voice 策略的配置,當下發策略包含 voice 時返回 "template_type": 1 // voice 範本類型,目前僅支援預設範本,即固定取值為 1 }, "email_config": { // email 策略的配置,當下發策略包含 email 時返回 "template_name": "email範本名稱" // email 範本名稱 }, "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 範本預估的計費條數,範本過長則會具體的價格=計費條數*計費單價
    },
    "voice_config": {                           // voice 策略的配置,當下發策略包含 voice 時返回
        "template_type": 1                      // voice 範本類型,目前僅支援預設範本,即固定取值為 1
    },
    "email_config": {                           // email 策略的配置,當下發策略包含 email 時返回
        "template_name": "email範本名稱"        // email 範本名稱
    },
    "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 範本不存在
Icon Solid Transparent White Qiyu
聯繫銷售