อัปเดตการกำหนดค่าเทมเพลต

อัปเดตการกำหนดค่าเทมเพลตที่มีอยู่ รองรับการแก้ไขชื่อเทมเพลต ประเภท เนื้อหา ประเทศที่ส่ง และข้อมูลลายเซ็น หลังจากอัปเดตแล้ว สถานะเทมเพลตจะกลับเป็น "รอการตรวจสอบ"

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

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
}

            

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

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

พารามิเตอร์ของเนื้อหาคำขอ

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

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

รหัสสถานะ 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)