ลบการกำหนดค่าลายเซ็น

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

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

DELETE https://smsapi.engagelab.com/v1/sign-configs/:signId

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

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

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

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

DELETE /v1/sign-configs/987654321 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              DELETE /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

เนื้อหาคำขอ

ไม่มี

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

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

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
signId String จำเป็น ID ลายเซ็น

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

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

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

ฟิลด์ ประเภท คำอธิบาย
code Integer รหัสสถานะ 0 หมายถึงสำเร็จ
message String คำอธิบายสถานะ

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

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

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

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

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

ฟิลด์ ประเภท คำอธิบาย
code Integer รหัสข้อผิดพลาด
message String รายละเอียดข้อผิดพลาด

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

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

            
โค้ดนี้โชว์เป็นหน้าต่างลอย

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

รหัสข้อผิดพลาด http code คำอธิบาย
400 400 พารามิเตอร์ผิดพลาดหรือข้อผิดพลาดทางตรรกะธุรกิจ
500 500 ข้อผิดพลาดภายในเซิร์ฟเวอร์

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

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

ข้อควรทราบ

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