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

สร้างซองด่วน

POST /esignglobal/v1/envelope/createAndStart

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

เริ่มสร้างซองจดหมายอย่างรวดเร็ว รวมถึงการสร้างซองจดหมาย เพิ่มเอกสารที่ต้องลงนาม และเพิ่มผู้ลงนาม เป็นต้น

  • รองรับการเปิดอัตโนมัติ: หลังจากเรียกใช้ API สำเร็จ จะเป็นการสร้างและเปิดซองจดหมายสำเร็จ โดยซองจดหมายจะเริ่มดำเนินการต่อโดยอัตโนมัติในขณะนั้น
  • รองรับการสิ้นสุดอัตโนมัติ: เมื่อทุกฝ่ายที่เกี่ยวข้องกับการลงนามได้ลงนามเสร็จสิ้นแล้ว ซองจดหมายจะสิ้นสุดโดยอัตโนมัติ

 

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

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

ประเภท

จำเป็น

คำอธิบาย

subject

string

true

หัวข้อซองจดหมาย

ตัวอย่าง: “Offer Letter”

remark

string

false

หมายเหตุซองจดหมาย จำกัดความยาวไม่เกิน 1,000 ตัวอักษร

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

ต้องเป็นที่อยู่ https ที่ถูกต้อง

callBackUrl

string

false

ที่อยู่สำหรับเรียกกลับ (ความยาวสูงสุด 500 ตัวอักษร) ต้องเป็นไปตามโปรโตคอล https

sendLaterAfterSeconds

long

false

รองรับการส่งล่าช้าโดยผู้ใช้ หน่วยเป็นวินาที

ช่วงเวลาที่รองรับ: 3,600 วินาที (1 ชั่วโมง) ~ 259,200 วินาที (30 วัน)

autoFinish

boolean

false

ควบคุมว่าซองจะสิ้นสุดอัตโนมัติหรือไม่ ค่าเริ่มต้นคือ true

true-ซองสิ้นสุดอัตโนมัติ

false-ซองสิ้นสุดด้วยตนเอง

CCInfos

array

false

ชุดข้อมูลผู้รับสำเนา

 

userEmail

string

false

ที่อยู่อีเมลของผู้รับสำเนา

 

userName

string

false

ชื่อของผู้รับสำเนา ใช้สำหรับแสดงชื่อของผู้รับสำเนาในหน้าลงนามและบนซองจดหมาย

【หมายเหตุ】: ห้ามมีอักขระพิเศษทั้ง 9 ตัวต่อไปนี้: / \ : * " < > | ? และห้ามมีอีโมจิใดๆ

 

customizeSettings

object

false

การกำหนดค่าแบบกำหนดเอง

 

 

notificationSettings

object

false

การกำหนดค่าแบบกำหนดเองประเภทแจ้งเตือน

 

 

 

notificationLanguage

string

false

ภาษาสำหรับการแจ้งเตือน โดยจะดึงค่าจาก "ภาษาแจ้งเตือนเริ่มต้น" หากไม่ได้ระบุ

en-US อังกฤษ

zh-CN จีนตัวย่อ

zh-Hant จีนตัวเต็ม

ja-JP ญี่ปุ่น

es-MX สเปน

pt-PT โปรตุเกส
th-TH ไทย
id-ID อินโดนีเซีย
vi-VN ภาษาเวียดนาม
ms-MY ภาษามาเลย์
fil-PH ภาษาฟิลิปปินส์
de-DE ภาษาเยอรมัน
fr-FR ภาษาฝรั่งเศส
ru-RU ภาษารัสเซีย
it-IT ภาษาอิตาลี
ko-KR ภาษาเกาหลี

signFiles

array

true

ชุดข้อมูลเอกสารที่ลงนาม แสดงตามลำดับการเพิ่มเอกสาร

 

fileKey 

string

true

fileKey ของเอกสารที่ลงนาม รองรับเฉพาะรูปแบบ PDF เท่านั้น

 documentFieldsarrayfalseรายการคอนโทรลมิติเอกสาร ใช้เพื่อเพิ่มคอนโทรลมิติเอกสารที่ไม่ผูกกับผู้ลงนามบนเอกสารที่กำหนด

 

 

fieldType

string

false

ประเภทคอนโทรล ส่งค่า eMeterai เพื่อแสดงถึงคอนโทรลภาษีอากรของอินโดนีเซีย

 

 

pageNo

string

false

หมายเลขหน้าของคอนโทรล คอนโทรลภาษีอากรของอินโดนีเซียรองรับเฉพาะการระบุหน้าเดียว ต้องส่งหมายเลขหน้าเดี่ยว ไม่รองรับรูปแบบหลายหน้าต่อเนื่องหรือไม่ต่อเนื่อง เช่น 1-3, 1,3 เป็นต้น

  posXfloatfalseค่าเบี่ยงเบนแกน x จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่นๆ
  posYfloatfalseค่าเบี่ยงเบนแกน y จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่นๆ

attachments

array

false

ชุดไฟล์แนบในซองเอกสาร แสดงตามลำดับการเพิ่มไฟล์

 

fileKey 

string

false

fileKey ของไฟล์

signerInfos

array

true

ชุดข้อมูลผู้ลงนาม

 

businessId

string

false

หมายเลขธุรกิจที่กำหนดโดยนักพัฒนา จำกัดความยาวสูงสุด 500 ตัวอักษร

 

roleTypes

array

false

วิธีการดำเนินการของผู้ลงนาม ค่าเริ่มต้นคือ ["sign", "fill"]

fill-กรอกข้อมูล

sign-ลงนาม

 deliveryMethods

string

false

วิธีการแจ้งเตือน ค่าเริ่มต้นคือ auto

auto-เมื่อส่ง userEmail จะส่งการแจ้งเตือนทางอีเมล เมื่อส่ง phoneNumber จะส่งการแจ้งเตือนทางข้อความ SMS

none-ไม่ส่งการแจ้งเตือนข้อความ

email-ส่งการแจ้งเตือนทางอีเมล

sms-ส่งการแจ้งเตือนทางข้อความ SMS

WhatsApp-ส่งการแจ้งเตือนผ่าน WhatsApp

 

userEmail

string

false

ที่อยู่อีเมลของผู้ลงนาม

 

userName

string

true

ชื่อของผู้ลงนาม ใช้แสดงชื่อผู้ลงนามบนหน้าลงนามและในซองเอกสารภายนอก

【หมายเหตุ】ห้ามมีอักขระพิเศษทั้ง 9 ตัวต่อไปนี้: / \ : * " < > | ? และอิโมจิทั้งหมด

 minimumReadingDurationintfalseตั้งค่าเวลาถอยหลังบังคับอ่านในหน้าตั้งค่า ค่าเริ่มต้นคือ 0 (หน่วยเป็นวินาที, ค่าสูงสุด 999)
ค่า 0 หรือไม่ส่งหมายถึงไม่เปิดใช้งาน ไม่มีเวลาถอยหลังการอ่าน
 readToEndRequiredbooleanfalseบ่งชี้ว่าจำเป็นต้องอ่านจนจบหรือไม่ ค่าเริ่มต้นคือ false;
true หมายถึงเปิดใช้งาน, false หรือไม่ส่งหมายถึงไม่เปิดใช้งาน

 

phoneNumber

object

false

หมายเลขโทรศัพท์ ค่าเริ่มต้นเป็นค่าว่าง

เป็นพารามิเตอร์ที่จำเป็นเมื่อต้องการแจ้งเตือนผ่านข้อความ SMS ต้องส่ง countryCode และ number พร้อมกัน

 

 

countryCode

string

false

รหัสระหว่างประเทศของภูมิภาค/ประเทศ ไม่ต้องใส่ “+”

 

 

number

string

false

ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก

 

customizeSettings

object

false

การกำหนดค่าแบบกำหนดเอง

 

 

notificationSettings

object

false

การกำหนดค่าแบบกำหนดเองสำหรับประเภทการแจ้งเตือน

 

 

 

customizeMessage

string

false

การแจ้งเตือนข้อความเฉพาะ ข้อจำกัดตัวอักษร 200 ตัว

   

notificationLanguage

string

false

ภาษาของการแจ้งเตือน ใช้ค่าจากการกำหนดค่า “ภาษาแจ้งเตือนเริ่มต้น” โดยค่าเริ่มต้น

en-US ภาษาอังกฤษ

zh-CN ภาษาจีนตัวย่อ

zh-Hant ภาษาจีนตัวเต็ม

ja-JP ภาษาญี่ปุ่น

es-MX ภาษาสเปน

pt-PT ภาษาโปรตุเกส
th-TH ภาษาไทย
id-ID ภาษาอินโดนีเซีย
vi-VN ภาษาเวียดนาม
ms-MY ภาษามาเลย์
fil-PH ภาษาฟิลิปปินส์
de-DE ภาษาเยอรมัน
fr-FR ภาษาฝรั่งเศส
ru-RU ภาษารัสเซีย
it-IT ภาษาอิตาลี
ko-KR ภาษาเกาหลี

 

signOrder

int

true

ลำดับการลงนามของผู้ลงนาม มีค่าต่ำสุดคือ 1 การลงนามแบบไม่เรียงลำดับสามารถระบุค่าลำดับเดียวกันได้

 

anySigner

boolean

false

รองรับการลงนามโดยบุคคลใดก็ได้หรือไม่ ค่าเริ่มต้นคือ false

true- สำหรับ signOrder เดียวกัน ต้องมีเพียงหนึ่งคนลงนาม

false- สำหรับ signOrder เดียวกัน ทุกคนต้องลงนาม

 

authModes

string

false

วิธีการตรวจสอบ ค่าเริ่มต้นคือ noAuth

noAuth- ไม่มีการตรวจสอบ

accessCode- ใช้รหัสผ่านสำหรับการลงนามเพื่อตรวจสอบ

sms- การตรวจสอบด้วย SMS OTP

idVerification- การตรวจสอบด้วยบัตรประจำตัว

emailAuth- การตรวจสอบด้วยอีเมล OTP

digitalId- การตรวจสอบตัวตนอิเล็กทรอนิกส์

whatsappAuth- การตรวจสอบด้วย WhatsApp OTP

 

authConfig

object

false

การตั้งค่าวิธีการตรวจสอบ

 

 

accessCode

object

 

false

การตั้งค่ารหัสผ่านสำหรับการลงนาม เมื่อ authModes=accessCodeจำเป็นต้องกรอก

 

 

 

accessCode

string

false

เนื้อหาของรหัสผ่าน ไม่แยกแยะตัวพิมพ์ใหญ่-เล็ก สามารถประกอบด้วยตัวอักษรและตัวเลข ความยาวจำกัดที่ 45

   

promptInfo

string

false

ข้อความแจ้งเตือนรหัสผ่านเข้าถึง ไม่สามารถมีรหัสผ่านเข้าถึงได้ ความยาวสูงสุด 30 ตัวอักษร ต้องกรอกเมื่อ authModes=accessCode 

 

 

sms

object

false

การตรวจสอบ OTP ผ่าน SMS ต้องกรอกเมื่อ authModes=sms

 

 

 

countryCode

string

false

รหัสระหว่างประเทศของภูมิภาค/ประเทศ ไม่ต้องใส่เครื่องหมาย “+”

 

 

 

number

string

false

ไม่มีการตรวจสอบรูปแบบ จำกัดความยาวสูงสุดเพียง 13 หลัก

 

 

idVerification

object

false

การตั้งค่าการยืนยันตัวตนด้วยบัตรประจำตัว ต้องกรอกเมื่อ authModes=idVerification

 

 

 

name

string

false

ชื่อเต็มบนบัตรประจำตัวของผู้อ้างอิง ความยาวสูงสุด 100 ตัวอักษร

  

emailAuth

object

false

การตรวจสอบ OTP ผ่านอีเมล ต้องกรอกเมื่อ authModes=emailAuth

  

 

authEmail

string

false

ที่อยู่อีเมลสำหรับยืนยันตัวตนของผู้อ้างอิง

 

 

digitalId

array

false

การยืนยันตัวตนแบบดิจิทัล ต้องกรอกเมื่อ authModes=digitalId

 

 

 

authApp

string

false

แอปพลิเคชันที่ใช้สำหรับการยืนยันตัวตนแบบดิจิทัล

singpass- ใช้ Singpass สำหรับการยืนยันตัวตน

iamsmart-ใช้ i AM Smart สำหรับการยืนยันตัวตน

 

 

 

idNumber

string

false

หมายเลขบัตรประจำตัวของผู้ลงนามที่ยังรอการตรวจสอบ

เมื่อ authApp=singpassกฎของการส่งข้อมูลคือ: ตัวอักษรพิมพ์ใหญ่ + ตัวเลข 7 หรือ 8 หลัก + ตัวอักษรพิมพ์ใหญ่

เมื่อ authApp=iamsmartกฎของการส่งข้อมูลคือ:

1. ตัวอักษรพิมพ์ใหญ่หนึ่งตัว (A-Z) หรือสองตัว (AA-ZZ) เป็นส่วนเริ่มต้นของลำดับ;

2. ตามด้วยตัวเลข 6 หลัก;

3. สุดท้ายเป็นรหัสตรวจสอบ ซึ่งอาจเป็นตัวเลข (0-9) หรือตัวอักษร (A-Z) ตัวอย่าง: A888888(A)

 

 

whatsappAuth

object

false

การยืนยัน OTP ของ WhatsApp จำเป็นต้องระบุเมื่อ authModes=whatsappAuth

 

 

 

countryCode

string

false

รหัสระหว่างประเทศของประเทศ/ภูมิภาค ไม่ต้องใส่ “+”

 

 

 

number

string

false

ไม่มีการตรวจสอบรูปแบบ แต่จำกัดความยาวสูงสุดไว้ที่ 13 หลัก

 

digitalSignature

boolean

false

เปิดใช้งานลายเซ็นดิจิทัลหรือไม่ ค่าเริ่มต้นคือ false

true-เปิดใช้งาน, false-ไม่เปิดใช้งาน

 

freeFormSign

boolean

false

ผู้ลงนามสามารถลงนามด้วยตนเองหรือไม่ ค่าเริ่มต้นคือ false

คำอธิบายเพิ่มเติม:

เมื่อตั้งค่า freeFormSign เป็น true ไม่จำเป็นต้องส่งพารามิเตอร์อื่นๆ ภายใต้ sealInfos หากส่งทั้งสองอย่างพร้อมกัน freeFormSign จะมีความสำคัญสูงกว่า sealInfos และพารามิเตอร์ภายใต้ sealInfos จะไม่ถูกนำไปใช้

【ข้อควรระวัง】การลงนามแบบอิสระหมายถึงการไม่จำกัดจำนวนและตำแหน่งของตราประทับ/ลายมือชื่อที่ผู้ลงนามสามารถลากวางได้

 

sealInfos

array

false

ข้อมูลงานลงนาม

 

 

fileKey

string

true

fileKey ของไฟล์ที่ลงนาม

 

 

signConfigs

array

false

ข้อมูลตำแหน่งของคอนโทรล ต้องระบุข้อมูลตำแหน่งของคอนโทรลจึงจะสามารถดำเนินการลงนามอิเล็กทรอนิกส์ได้

 

 

 

fieldType

string

false

ประเภทของคอนโทรล ค่าเริ่มต้นคือ signature

signature-คอนโทรลลายมือชื่อ

stamp-คอนโทรลตราประทับ

approval-คอนโทรลการอนุมัติ

   

required

boolean

false

เป็นฟิลด์บังคับหรือไม่ ค่าเริ่มต้นคือบังคับ

true-บังคับ

false-ไม่บังคับ

   

signFieldStyle

string

false

วิธีการวางตราประทับบนคอนโทรลลงนาม ค่าเริ่มต้นคือ normalSeal

normalSeal-ลายเซ็นและตราประทับทั่วไป

pagingSeal-ตราประทับข้ามหน้า

เฉพาะวิดเจ็ตลายเซ็นและวิดเจ็ตตราประทับเท่านั้นที่รองรับการตั้งค่าตราประทับข้ามหน้า

   

pagingSealMode

string

false

ช่วงจำนวนหน้าที่ตราประทับข้ามหน้าจะถูกประทับ โดยค่าเริ่มต้นคือ all

all-ทุกหน้า

assignedPages-ระบุหมายเลขหน้า

even-หน้าคู่

odd-หน้าคี่

รองรับการระบุเฉพาะเมื่อ signFieldStyle=pagingSeal เท่านั้น

   

sizeRule

string

false

วิธีการแสดงขนาดพื้นที่ลงนาม

originalSize-ประทับตามขนาดจริงของลายเซ็น/ตราประทับ

targetSize-กำหนดความกว้างและความสูงของพื้นที่ลายเซ็น/ตราประทับเอง

เมื่อ sizeRule, height และ width เป็นค่าว่างทั้งหมด ให้ประทับตามขนาดจริงของลายเซ็น/ตราประทับ

เมื่อ sizeRule เป็นค่าว่าง แต่ height และ width ไม่ใช่ค่าว่าง ให้ประทับตามขนาดที่กำหนด

เมื่อ sizeRule ไม่ใช่ค่าว่าง ให้ประทับตามวิธีการแสดงผลที่กำหนด

ไม่จำเป็นต้องระบุพารามิเตอร์นี้สำหรับตราประทับข้ามหน้ากระดาษ โดยจะประทับตามขนาดจริง

 

 

 

height

int

false

ความสูงขององค์ประกอบลงนาม ใช้ได้กับ fieldType เป็น signature/stamp หน่วยเป็น px รับเฉพาะจำนวนเต็มบวกเท่านั้น ค่าเริ่มต้นคือ auto (ระบบจะกำหนดขนาดอัตโนมัติ);

เมื่อ fieldType=signature สามารถตั้งค่าได้ในช่วง 20-250px;

เมื่อ fieldType=stamp สามารถตั้งค่าได้ในช่วง 30-280px;

ไม่จำเป็นต้องระบุพารามิเตอร์นี้สำหรับตราประทับข้ามหน้ากระดาษ

 

 

 

width

int

false

ความกว้างขององค์ประกอบลงนาม ใช้ได้กับ fieldType เป็น signature/stamp หน่วยเป็น px รับเฉพาะจำนวนเต็มบวกเท่านั้น ค่าเริ่มต้นคือ auto (ระบบจะกำหนดขนาดอัตโนมัติ);

เมื่อ fieldType=signature สามารถตั้งค่าได้ในช่วง 20-250px;

เมื่อ fieldType=stamp สามารถตั้งค่าได้ในช่วง 30-280px;

ไม่จำเป็นต้องระบุพารามิเตอร์นี้สำหรับตราประทับข้ามหน้ากระดาษ

 

 

 

signatureOptions

string

false

ตัวเลือกสำหรับองค์ประกอบลายเซ็น ใช้ได้เฉพาะกับ fieldType เป็น signature

ค่าที่ส่งเข้าได้:

template: ลายเซ็นจากแม่แบบ

handDrawn: ลายเซ็นวาดด้วยมือ

upload: อัพโหลดรูปภาพลายเซ็นจากเครื่องท้องถิ่น

สามารถเลือกได้หลายค่า คั่นด้วย "," ค่าเริ่มต้นคือการเลือกทั้งหมด

 

 

 

movable

boolean

false

อนุญาตให้เลื่อนตำแหน่งได้ขณะลงนาม โดยค่าเริ่มต้นคือ false

false-ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งขององค์ประกอบลงนามของตนเอง

true-อนุญาตให้ผู้ลงนามปรับตำแหน่งขององค์ประกอบลงนามของตนเอง

 

 

 

allowedOptions

array

false

ตัวเลือกที่อนุญาตให้ผู้ลงนามอนุมัติ ใช้เมื่อ fieldType เป็น approval ค่าเริ่มต้นคือ ["approve", "decline"]

approve-เห็นชอบ

decline-ไม่เห็นชอบ

 

 

 

pageNo

string

false

หมายเลขหน้าเอกสารสำหรับลงนาม; หน้าต่อเนื่องใช้เครื่องหมาย "-" คั่น และหน้าเดี่ยวใช้เครื่องหมาย "," คั่น

ตัวอย่าง: 1-3,6-10

ระบุช่วงหมายเลขหน้าที่ประทับตราข้ามหน้า เมื่อ pagingSealMode=assignedPages ตราข้ามหน้าใช้ได้เฉพาะกับไฟล์ที่มีมากกว่า 1 หน้าเท่านั้น

 

 

 

posX

float

false

พิกัดแกน x

【หมายเหตุ】หาก fieldType เป็น signature พิกัดจะหมายถึงพื้นที่ลายเซ็นมุมล่างซ้าย

หาก fieldType เป็น stamp พิกัดจะหมายถึงพื้นที่การประทับตราจุดศูนย์กลางตำแหน่ง

ตั้งแต่วันที่ 3 กุมภาพันธ์ 2026 เป็นต้นไป หาก fieldType เป็น signature หรือ stamp ตำแหน่งพิกัดจะหมายถึงจุดศูนย์กลางของพื้นที่ประทับตรา

การประทับตราข้ามหน้าสามารถส่งค่าเป็น 0 ได้ แต่ไม่สามารถส่งค่า null ได้ โดยองค์ประกอบจะถูกตรึงไว้ที่ขอบด้านขวาของเอกสาร

 

 

 

posY

float

false

พิกัดแกน y

【ข้อควรระวัง】หาก fieldType เป็น signature แล้ว ตำแหน่งพิกัดจะหมายถึงพื้นที่ลายเซ็นมุมล่างซ้าย

หาก fieldType เป็น stamp แล้ว ตำแหน่งพิกัดจะหมายถึงพื้นที่ประทับตราจุดศูนย์กลางตำแหน่ง

ตั้งแต่วันที่ 3 กุมภาพันธ์ 2026 เป็นต้นไป หาก fieldType เป็น signature หรือ stamp ตำแหน่งพิกัดจะหมายถึงจุดศูนย์กลางของพื้นที่ประทับตรา

 

 

fillConfigs

array

false

กรอกข้อมูลองค์ประกอบ

 

 

 

fieldName

string

false

ชื่อองค์ประกอบ จำกัดความยาวตัวอักษร 128 ตัว

 

 

 

required

boolean

false

ระบุว่าเป็นช่องบังคับหรือไม่ ค่าเริ่มต้นคือบังคับ

true-บังคับ

false-ไม่บังคับ

 

 

 

fieldType

string

false

ประเภทองค์ประกอบ:

1-ข้อความบรรทัดเดียว

15-ช่องทำเครื่องหมาย

 

 

 

textField

object

false

คุณสมบัติของคอนโทรลข้อความ

 

 

 

 

overflowType

int

false

มีผลเฉพาะกับ text เท่านั้น, ค่าเริ่มต้นคือ 1

1-ปรับขนาดตัวอักษรอัตโนมัติ

2-จำกัดการป้อนข้อมูล

 

 

 

 

minFontSize

float

false

มีผลเฉพาะกับ text เท่านั้น, มีผลเฉพาะเมื่อ overflowType=1, ค่าเริ่มต้นคือ 8

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

 

width

int

false

ความกว้างของคอนโทรล, ค่าเริ่มต้นคือ 160px

 

 

 

 

font

int

false

มีผลเฉพาะกับ text เท่านั้น, ฟอนต์, ค่าเริ่มต้นคือ Songti

1-Songti

2-New Songti

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-FangSong

11-Georgia

12-Monospace

 

 

 

 

fontSize

float

false

มีผลเฉพาะกับ text เท่านั้น, ขนาดตัวอักษร, ค่าเริ่มต้นคือ 12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

 

textColor

string

false

มีผลเฉพาะกับ text เท่านั้น, สีแบบ hexadecimal, ค่าเริ่มต้นคือสีดำ #000

 

 

 

 

bold

boolean

false

มีผลเฉพาะกับ text เท่านั้น, ตัวอักษรเป็นตัวหนาหรือไม่, ค่าเริ่มต้นคือ false

true-ตัวหนา

false-ไม่ตัวหนา

 

 

 

 

italic

boolean

false

มีผลเฉพาะกับ text เท่านั้น, ตัวอักษรเป็นตัวเอียงหรือไม่, ค่าเริ่มต้นคือ false

true-ตัวเอียง

false-ไม่ตัวเอียง

 

 

 

 

underline

boolean

false

มีผลเฉพาะกับ text เท่านั้น, ตัวอักษรมีการขีดเส้นใต้หรือไม่, ค่าเริ่มต้นคือ false

true-ขีดเส้นใต้

false-ไม่ขีดเส้นใต้

 

 

 

 

lineThrough

boolean

false

มีผลเฉพาะกับ text เท่านั้น, ตัวอักษรมีการขีดฆ่าหรือไม่, ค่าเริ่มต้นคือ false

true-ขีดฆ่า

false-ไม่ขีดฆ่า

 

 

 

 

horizontalAlignment

string

false

มีผลเฉพาะกับ text เท่านั้น, การจัดรูปแบบกึ่งกลางแนวนอน, ค่าเริ่มต้นคือ left

LEFT-ชิดซ้าย

CENTER-จัดกึ่งกลาง

RIGHT-ชิดขวา

 

 

 

tickBoxField

object

false

คุณสมบัติของช่องทำเครื่องหมาย

 

 

 

 

tickOptions

array

false

มีผลเฉพาะกับ tickBox เท่านั้น ค่าเริ่มต้นคือ 1

1-เครื่องหมายถูก

2-เครื่องหมายกากบาท

 

 

 

posX

float

false

พิกัด X ของตำแหน่งควบคุม

 

 

 

posY

float

false

พิกัด Y ของตำแหน่งควบคุม

 

 

 

pageNo

string

false

หมายเลขหน้าของตำแหน่งควบคุม

 

 

signDateConfigs

array

false

ข้อมูลตำแหน่งวันที่ลงนาม

 

 

 

movable

boolean

false

อนุญาตให้ย้ายตำแหน่งขณะลงนาม ค่าเริ่มต้นคือ false

false-ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งเครื่องมือลงนามของตนเอง

true-อนุญาตให้ผู้ลงนามปรับตำแหน่งเครื่องมือลงนามของตนเอง

 

 

 

pageNo

string

false

หมายเลขหน้าที่ลงนาม; หน้าต่อเนื่องใช้ "-" คั่น หน้าที่ไม่ต่อเนื่องใช้ "," คั่น ตัวอย่าง: 1-3, 6-10;

หากไม่ใช่หน้าต่อเนื่อง ให้ใช้ "," ในการแบ่ง

 

 

 

posX

float

false

ค่าการเลื่อนแกน x โดยที่มุมล่างซ้ายของหน้ากระดาษเป็นจุดกำเนิดของพิกัด

 

 

 

posY

float

false

ค่าการเลื่อนแกน y โดยที่มุมล่างซ้ายของหน้ากระดาษเป็นจุดกำเนิดของพิกัด

 

 

 

signDateFormat

string

false

รูปแบบวันที่เซ็นชื่อ รูปแบบเริ่มต้นคือ yyyy-MM-dd

รองรับรูปแบบที่กำหนด:

ปี yyyy เดือน MM วัน dd

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

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

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

 

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

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

ประเภท

คำอธิบาย

envelopeId

string

ID ของซองเอกสาร

CCInfos

array

ชุดข้อมูลของผู้รับสำเนา

 

userEmail

string

ที่อยู่อีเมลของผู้รับสำเนา

 

userName

string

ชื่อของผู้รับสำเนา

signFiles

array

ชุดข้อมูลข้อมูลไฟล์เซ็นชื่อ

 

fileKey

string

ลงนามในไฟล์ fileKey

attachments

array

ชุดไฟล์แนบของซองจดหมาย

 

fileKey

string

ไฟล์ fileKey

signerInfos

array

ข้อมูลการลงนาม

 

recipientId

string

ID ของผู้ลงนาม

 

businessId

string

หมายเลขธุรกิจที่กำหนดโดยนักพัฒนาเอง ความยาวจำกัด 500

 

userEmail

string

ที่อยู่อีเมลของผู้ลงนาม

 

userName

string

ชื่อของผู้ลงนาม

 signUrlstringที่อยู่ลิงก์การลงนาม

 

signOrder

int

ลำดับการลงนามของผู้ลงนาม ค่าต่ำสุดคือ 1

 

accessCode

string

รหัสผ่านสำหรับการเข้าถึงหน้าลงนาม

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

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}