eSign.AIeSign.AI
ศูนย์นักพัฒนา

ยกเลิกการบล็อกซองจดหมาย

POST/esignglobal/v1/envelope/recipients/resumeSignTask

คำอธิบายอินเทอร์เฟซ

ยกเลิกการบล็อกโหนดเฉพาะในกระบวนการลงนามโดยใช้ ID ของซองและตัวระบุโหนดที่บล็อก เพื่อให้กระบวนการลงนามดำเนินการต่อได้

หมายเหตุ:

  • รองรับการยกเลิกโหนดที่ถูกบล็อกล่วงหน้าที่ยังไม่มาถึง รวมถึงโหนดที่อยู่ในสถานะถูกบล็อกแล้ว
  • จะคืนค่าความล้มเหลวทางธุรกิจหากซองหรือโหนดที่บล็อกไม่มีอยู่ ซองเข้าสู่สถานะสุดท้าย หรือมีการยกเลิกซ้ำพร้อมกัน

 

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

ชื่อพารามิเตอร์

ประเภท

จำเป็น

คำอธิบาย

envelopeId

string

true

ID ของซอง

suspensionKey

string

true

ตัวระบุโหนดที่บล็อก ห้ามเว้นว่าง ความยาวสูงสุด 500 ตัวอักษร ต้องเป็นค่าที่ไม่ซ้ำภายในซองเดียวกัน และต้องส่งคีย์ที่กำหนดไว้ตอนเริ่มต้น

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

{
    "envelopeId": "{{envelope-id}}",
    "suspensionKey": "approval-node-001"
}

พารามิเตอร์การตอบกลับ

ชื่อพารามิเตอร์

ประเภท

คำอธิบาย

code

string

รหัสการตอบกลับ,0 แสดงถึงความสำเร็จ

data

object

ข้อมูลการตอบกลับ คืนค่าเป็นออบเจกต์ว่างเมื่อปลดล็อกสำเร็จ

message

string

ข้อความการตอบกลับ

ตัวอย่างการตอบกลับ

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