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

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-ไม่อนุญาตให้ผู้ลงนามแก้ไขชื่อ
tspScope		array	false	ขอบเขต TSP ระดับซองจดหมาย ค่าเริ่มต้นคือ false หลังจากกำหนดแล้ว เมื่อเพิ่มผู้ลงนาม จะต้องเลือก TSP ที่ผู้ลงนามต้องการใช้จากขอบเขตที่กำหนด ค่าที่เป็นไปได้มีดังนี้: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。
expireAfterSeconds		long	false	เวลาหมดอายุของซองจดหมาย: จำนวนวินาทีที่ซองจดหมายจะหมดอายุหลังจากนั้น ช่วงหมดอายุ: 86,400 วินาที (1 วัน) ~ 7,776,000 วินาที (90 วัน)
redirectUrl		string	false	ที่อยู่สำหรับการเปลี่ยนเส้นทางหลังการลงนามเสร็จสิ้น (ความยาว 2048) ต้องเป็น URL http ที่ถูกต้อง
callBackUrl		string	false	ที่อยู่สำหรับเรียกกลับ (ความยาว 500) ต้องเป็น URL ที่สอดคล้องกับโปรโตคอล https/http

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

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "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"
}