更新範本設定

更新已存在的範本設定，支援修改範本名稱、類型、內容、發送國家及簽名資訊。更新後範本狀態會變回"待審核"。

呼叫位址

PUT https://smsapi.engagelab.com/v1/template-configs/:templateId

呼叫驗證

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

請求範例

請求標頭

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

            

請求主體

              
              {
  "template_name": "訂單通知範本",
  "template_type": "utility",
  "template_content": "您的訂單{order_no}已發貨，預計{delivery_time}送達",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

            

請求參數

路徑參數

請求主體參數

回傳參數

成功返回

http 狀態碼為 200，回應主體包含欄位如下：

成功範例

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

            

失敗返回

http 狀態碼為 4xx/5xx，回應主體包含欄位如下：

異常範例

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

錯誤碼

常見錯誤資訊：

• invalid templateId：範本 ID 格式錯誤
• template config not exist：範本設定不存在
• can not update pending status template：待審核狀態的範本不能更新
• there are pending or running plans using current template, can not update：存在使用該範本的待發送或執行中的計畫，不能更新
• sign config not exist：簽名設定不存在
• sign status is not approved, can not use：簽名狀態未審核通過，不能使用

注意事項

1. 待審核狀態的範本不能更新
2. 如果存在待發送或執行中的訊息計畫使用該範本，則不能更新
3. 更新後範本狀態會變回"待審核"（status=1）
4. 如果加入簽名，簽名必須是已審核通過狀態
5. 範本內容不能包含禁用字元：【、】、、、測試、test、[、]
6. 範本和簽名的 ID 都是字串類型的數字

附錄

範本設定狀態 (status)

範本類型 (template_type)

簽名位置 (sign_position)