ลบการกำหนดค่าเทมเพลต

ลบการกำหนดค่าเทมเพลตที่ระบุ หากเทมเพลตกำลังถูกใช้งานโดยแผนข้อความ (สถานะรอการส่งหรือกำลังทำงาน) จะไม่สามารถลบได้

URL สำหรับเรียกใช้

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

การยืนยันตัวตนในการเรียกใช้

โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธียืนยันตัวตน API

ตัวอย่างคำขอ

ส่วนหัวของคำขอ

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

            

เนื้อหาคำขอ

ไม่มี

พารามิเตอร์ของคำขอ

พารามิเตอร์ของเส้นทาง (Path)

พารามิเตอร์ที่ส่งกลับ

การตอบกลับเมื่อสำเร็จ

รหัสสถานะ HTTP เป็น 200 เนื้อหาการตอบกลับมีฟิลด์ดังนี้:

ตัวอย่างเมื่อสำเร็จ

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

            

การตอบกลับเมื่อล้มเหลว

รหัสสถานะ HTTP เป็น 4xx/5xx เนื้อหาการตอบกลับมีฟิลด์ดังนี้:

ตัวอย่างข้อผิดพลาด

              
              {
  "code": 400,
  "message": "there are pending or running plans using current template, can not update"
}

            

รหัสข้อผิดพลาด

ข้อความข้อผิดพลาดที่พบบ่อย:

• invalid templateId: รูปแบบ ID เทมเพลตไม่ถูกต้อง
• template config not exist: ไม่มีการกำหนดค่าเทมเพลต
• there are pending or running plans using current template, can not update: มีแผนที่รอการส่งหรือกำลังทำงานที่ใช้เทมเพลตนี้อยู่ ไม่สามารถลบได้

ข้อควรทราบ

1. หากมีแผนข้อความที่รอการส่งหรือกำลังทำงานใช้เทมเพลตนี้อยู่ จะไม่สามารถลบได้
2. ID ของทั้งเทมเพลตและลายเซ็นเป็นตัวเลขแบบสตริง