อัปเดตการกำหนดค่าลายเซ็น
อัปเดตการกำหนดค่าลายเซ็นที่มีอยู่ รองรับการแก้ไขชื่อลายเซ็น หลังจากอัปเดตแล้ว สถานะลายเซ็นจะกลับเป็น "รอการตรวจสอบ"
URL สำหรับเรียกใช้
PUT https://smsapi.engagelab.com/v1/sign-configs/:signId
การยืนยันตัวตนในการเรียกใช้
โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธียืนยันตัวตน API
ตัวอย่างคำขอ
ส่วนหัวของคำขอ
PUT /v1/sign-configs/987654321 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
PUT /v1/sign-configs/987654321 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
โค้ดนี้โชว์เป็นหน้าต่างลอย
เนื้อหาคำขอ
{
"sign_name": "ชื่อบริษัท"
}
{
"sign_name": "ชื่อบริษัท"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
พารามิเตอร์ของคำขอ
พารามิเตอร์ของเส้นทาง (Path)
| พารามิเตอร์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| signId | String | จำเป็น | ID ลายเซ็น |
พารามิเตอร์ของเนื้อหาคำขอ
| พารามิเตอร์ | ประเภท | ตัวเลือก | คำอธิบาย |
|---|---|---|---|
| sign_name | String | จำเป็น | ชื่อลายเซ็น ความยาว 2-60 อักขระ ห้ามมี: 【、】、[、] |
พารามิเตอร์ที่ส่งกลับ
การตอบกลับเมื่อสำเร็จ
รหัสสถานะ 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": "can not update pending status sign"
}
{
"code": 400,
"message": "can not update pending status sign"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
| รหัสข้อผิดพลาด | http code | คำอธิบาย |
|---|---|---|
| 400 | 400 | พารามิเตอร์ผิดพลาดหรือข้อผิดพลาดทางตรรกะธุรกิจ |
| 500 | 500 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ |
ข้อความข้อผิดพลาดที่พบบ่อย:
invalid signId: รูปแบบ ID ลายเซ็นไม่ถูกต้องsign config not exist: ไม่มีการกำหนดค่าลายเซ็นsign_name already exist: ชื่อลายเซ็นมีอยู่แล้วcan not update pending status sign: ไม่สามารถอัปเดตลายเซ็นที่อยู่ในสถานะรอการตรวจสอบได้there are pending or running plans using current sign, can not update: มีแผนที่รอส่งหรือกำลังทำงานอยู่ที่ใช้ลายเซ็นนี้ จึงไม่สามารถอัปเดตได้
ข้อควรทราบ
- ไม่สามารถอัปเดตลายเซ็นที่อยู่ในสถานะรอการตรวจสอบได้
- หากมีแผนข้อความที่รอส่งหรือกำลังทำงานอยู่ที่ใช้ลายเซ็นนี้ จะไม่สามารถอัปเดตได้
- หลังจากอัปเดตแล้ว สถานะลายเซ็นจะกลับเป็น "รอการตรวจสอบ" (status=1)
- ชื่อลายเซ็นต้องไม่มีอักขระต้องห้าม:
【、】、[、] - ID ของลายเซ็นเป็นตัวเลขแบบสตริง
ภาคผนวก
สถานะการกำหนดค่าลายเซ็น (status)
| ค่า | คำอธิบาย |
|---|---|
| 1 | รอการตรวจสอบ |
| 2 | ผ่านการตรวจสอบ |
| 3 | ปฏิเสธการตรวจสอบ |










