สร้างซองจดหมาย

POST /esignglobal/v1/envelope/create

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

สร้างซองจดหมายในสถานะฉบับร่าง

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

ชื่อพารามิเตอร์		ประเภท	จำเป็น	คำอธิบาย
subject		string	true	หัวข้อซองจดหมาย ตัวอย่าง: "Offer Letter"
remark		string	false	หมายเหตุซองจดหมาย จำกัดความยาว 1000 ตัวอักษร
signerSettings		object	false	การดำเนินการที่ผู้ลงนามได้รับอนุญาต
	allowTransfer	boolean	false	อนุญาตให้ผู้ลงนามส่งต่อซองจดหมายนี้ให้ผู้อื่นลงนามได้หรือไม่ ค่าเริ่มต้นคือ false true- อนุญาตให้ผู้ลงนามในซองจดหมายมีอำนาจในการส่งต่อซองจดหมายให้ผู้อื่น false- ไม่อนุญาตให้ผู้ลงนามในซองจดหมายมีอำนาจในการส่งต่อซองจดหมายให้ผู้อื่น
	allowModifyName	boolean	false	อนุญาตให้ผู้ลงนามแก้ไขชื่อได้หรือไม่ ใช้ได้เฉพาะกับการเซ็นชื่อเทมเพลตเท่านั้น ค่าเริ่มต้นคือ false true- อนุญาตให้ผู้ลงนามแก้ไขชื่อ false- ไม่อนุญาตให้ผู้ลงนามแก้ไขชื่อ
expireAfterSeconds		long	false	เวลาหมดอายุของซองจดหมาย: ซองจดหมายจะหมดอายุหลังจากผ่านไปกี่วินาที ช่วงหมดอายุ: 86,400 วินาที (1 วัน) ~ 7,776,000 วินาที (90 วัน)
redirectUrl		string	false	ที่อยู่เปลี่ยนเส้นทางเมื่อลงนามเสร็จสิ้น (ความยาว 2048) ต้องเป็นที่อยู่ http ที่ถูกต้อง
callBackUrl		string	false	ที่อยู่ Callback (ความยาว 500) ต้องเป็นไปตามที่อยู่โปรโตคอล https /http

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

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

พารามิเตอร์การตอบสนอง

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

ประเภท

คำอธิบาย

envelopeId

string

ID ซองจดหมาย

envelopeStatus

int

สถานะซองจดหมาย

0-สร้างแล้ว (ฉบับร่าง)

1-กำลังลงนาม

2-เสร็จสมบูรณ์

3-หมดอายุ

5-ถูกเพิกถอน

ตัวอย่างการตอบสนอง

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}