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

เพิ่มผู้ลงนาม

POST/esignglobal/v1/envelope/recipients/addSigners

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

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

หมายเหตุ:

  • สำหรับซองจดหมายที่เริ่มต้นแบบทีละขั้นตอน จำเป็นต้องสิ้นสุดด้วยตนเอง
  • ก่อนที่กระบวนการของซองจดหมายจะเสร็จสิ้น สามารถเพิ่มผู้ลงนามได้ตลอดเวลา
  • เมื่อเพิ่มผู้ลงนามใหม่,สามารถเพิ่มได้เฉพาะที่ส่วนท้ายของขั้นตอนปัจจุบันเท่านั้น ไม่สามารถแทรกไว้ข้างหน้าผู้ที่กำลังลงนามหรือลงนามเรียบร้อยแล้ว
  • ภายใต้ลำดับการลงนามเดียวกัน ผู้ลงนามรายเดียวกัน (ตัดสินโดยอีเมลเป็นหลัก หากไม่มีอีเมลให้ใช้หมายเลขโทรศัพท์) ไม่สามารถเพิ่มซ้ำได้ หากต้องการแก้ไขข้อมูล โปรดลบออกแล้วเพิ่มใหม่
  • ในหนึ่งซองจดหมายจะมีผู้ลงนามได้สูงสุดเพียง 10 คน

 

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

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

ประเภท

จำเป็น

คำอธิบาย

envelopeId

string

true

ID ของซองจดหมาย

signerInfos

array

true

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

 

businessId

string

false

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

 

roleTypes

array

false

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

fill-กรอก

sign-ลงนาม

 deliveryMethods

string

false

วิธีการแจ้งเตือน ค่าเริ่มต้นคือ auto
auto-เมื่อส่ง userEmail จะส่งการแจ้งเตือนทางอีเมล เมื่อส่ง phoneNumber จะส่งการแจ้งเตือนทางข้อความสั้น
none-ไม่ส่งการแจ้งเตือนข้อความ
email-ส่งการแจ้งเตือนทางอีเมล
sms-ส่งการแจ้งเตือนทางข้อความสั้น
WhatsApp-ส่งการแจ้งเตือนผ่าน WhatsApp

 

userEmail

string

false

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

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

 

documentVisibility

object

false

การตั้งค่าความมองเห็นของไฟล์ โดยค่าเริ่มต้นจะแสดงทั้งหมด

 

 

documentViewType

string

false

กลยุทธ์การแสดงผล ค่าเริ่มต้นคือ all; all หมายถึงสามารถดูเอกสารทั้งหมดในซองลงนามได้, limited หมายถึงสามารถดูเฉพาะเอกสารที่ตนเองลงนามและเอกสารเสริมที่อนุญาตให้ดูเท่านั้น

 

 

viewableFileKeys

array

false

รายการ fileKey ที่กำหนดให้ผู้ลงนามสามารถดูเพิ่มเติมได้; สามารถส่งค่าและใช้งานได้เฉพาะเมื่อ documentViewType=limited เท่านั้น

 

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 ภาษาเกาหลี

 

userName

string

true

ชื่อผู้ลงนาม ใช้แสดงชื่อผู้ลงนามในหน้าและกระบวนการลงนามต่อสาธารณะ

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

 

signOrder

int

true

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

 

signTaskSuspend

boolean

false

ตั้งค่าโหนดบล็อกกระบวนการก่อนตำแหน่งลงนามนี้หรือไม่ ค่าเริ่มต้นคือ false true-ตั้งค่าโหนดบล็อก; false-ไม่ตั้งค่าโหนดบล็อก การกำหนดค่าการบล็อกภายในกลุ่มหรือเซ็นตามลำดับ (signOrder) เดียวกันต้องสอดคล้องกัน

 

suspensionKey

string

false

ตัวระบุโหนดบล็อก มีความยาวสูงสุด 500 ตัวอักษร และต้องเป็นค่าที่ไม่ซ้ำกันในซองเดียวกัน จำเป็นต้องระบุเมื่อ signTaskSuspend=true; ห้ามส่งค่าเมื่อ signTaskSuspend=false หรือไม่ได้ส่งค่า

 

suspendReason

string

false

สาเหตุของการบล็อก ต้องไม่ว่างเปล่าเมื่อส่งค่า进来 และความยาวสูงสุด 50 ตัวอักษร ส่งค่าได้เฉพาะเมื่อ signTaskSuspend=true; หากไม่ส่งค่า จะถือว่าจำเป็นต้องรอการประมวลผลจากระบบภายนอก ห้ามส่งค่าเมื่อ signTaskSuspend=false หรือไม่ได้ส่งค่า

 

anySigner

boolean

false

อนุญาตให้ใครก็ได้เซ็นหรือไม่ ค่าเริ่มต้นคือ false

true-ใน signOrder เดียวกัน มีเพียงคนเดียวที่ต้องเซ็น

false-ทุกคนใน signOrder เดียวกันต้องเซ็น

 

authModes

string

false

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

ประเภทข้อมูลแบบ enumerated:

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

การยืนยัน SMS OTP เมื่อ 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- ใช้ SmartID สำหรับการยืนยันตัวตน

 

 

 

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- ไม่เปิดใช้งาน

 

tsp

string

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

 

freeFormSign

boolean

false

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

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

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

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

 

sealInfos

array

false

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

 

 

fileKey

string

true

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

 

 

signConfigs

array

false

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

 

 

 

fieldType

 

string

false

ประเภทของคอนโทรล สามารถส่งพารามิเตอร์เข้าได้:

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

stamp-ควบคุมตราประทับ

approval-ควบคุมการอนุมัติ

ค่าเริ่มต้นคือ signature

   

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

aiHandDrawn

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

 

 

 

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

 

string

false

พิกัดแกน X

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

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

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

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

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

 

 

 

posY

 

string

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-ฟอนต์ Xin Song

4-ฟอนต์ Hei

5-ฟอนต์ Kai

6-Arial

7-Helvetica

9-Times New Roman

10-ฟอนต์ Fang Song

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 สีในรูปแบบ hex ค่าเริ่มต้นคือสีดำ #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

มีผลเฉพาะกับ Check เท่านั้น, ค่าเริ่มต้นคือ 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

MM dd yyyy

dd MM yyyy

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

{
    "envelopeId": "{{envelope-id}}",
    "signerInfos": [
        {
    	   "userEmail": "sender_user@esignglobal.com",
    	   "userName": "sender_user_name",
    	   "signOrder": 1,
    	   "signTaskSuspend": true,
    	   "suspensionKey": "approval-node-001",
    	   "suspendReason": "等待外部审批",
    	   "authModes": "sms",
           "authConfig": {
                "sms": {
                    "countryCode": "86",
                    "number": "158****9242"
                }
            },
            "sealInfos": [
                {
                    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
                    "signConfigs": [
                        {
                           "fieldType": "stamp",
                            "pageNo": "1",
                            "posX": 100.22,
                            "posY": 100
                        }
                    ],
                    "fillConfigs": [
                        {
                            "fieldId": "df0dd777bcc4d108de242d",
                            "fieldKey": "demo",
                            "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": "96e6c7d414f04e98938ea84013b",
                            "fieldKey": "红色加深斜体下划线删除线",
                            "pageNo": "1",
                            "posX": 94.516624,
                            "posY": 284.54953,
                            "fieldType": "1",
                            "required": false,
                            "textField": {
                                "overflowType": "1",
                                "minFontSize": 10.5,
                                "font": "1",
                                "fontSize": 12.0,
                                "textColor": "#E25041",
                                "bold": true,
                                "italic": true,
                                "lineThrough": true,
                                "horizontalAlignment": "LEFT"
                            }
                        },
                        {
                            "fieldId": "888b899853544c49bd819d9f6d1",
                            "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 ของซอง

signFiles

array

ชุดเอกสารลงนาม

 

fileKey 

string

fileKey ของเอกสารลงนาม

attachments

array

ชุดไฟล์แนบของซอง

 

fileKey 

string

fileKey ของไฟล์

signerInfos

array

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

 

recipientId

string

ID ของผู้เข้าร่วม

 

businessId

string

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

 

userEmail

string

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

 

userName

string

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

 

signOrder

int

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

 

 

accessCode

string

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

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

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "organizationName": "Esign Global CO.",
                "userLastName": "",
                "accessCode": "",
                "userEmail": "sender_user@tsign.cn",
                "userFirstName": "",
                "signOrder": "1"
            }
        ],
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "attachments": [
        ],
        "envelopeId": "9fbe6c8190824227bde29136b0145c81"
    },
    "message": "success"
}