eSignGlobaleSignGlobal
ศูนย์นักพัฒนา

เริ่มซองจดหมายอย่างรวดเร็ว

POST /esignglobal/v1/envelope/createAndStart

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

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

  • รองรับการเปิดใช้งานอัตโนมัติ:หลังจากเรียกใช้อินเทอร์เฟซสำเร็จ ซองจดหมายจะถูกสร้างและเปิดใช้งานสำเร็จ จากนั้นซองจดหมายจะเริ่มไหลเวียนโดยอัตโนมัติ
  • รองรับการสิ้นสุดอัตโนมัติ:หลังจากที่ผู้ลงนามทั้งหมดลงนามเสร็จสิ้น ซองจดหมายจะสิ้นสุดโดยอัตโนมัติ

 

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

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

ประเภท

จำเป็น

คำอธิบาย

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

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

callBackUrl

string

false

ที่อยู่ Callback (ความยาว 500) ต้องเป็นไปตามที่อยู่โปรโตคอล https

sendLaterAfterSeconds

long

false

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

ช่วงเวลารองรับ: 3600 วินาที (1 ชั่วโมง) ~ 259200 วินาที (30 วัน)

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 เท่านั้น

attachments

array

false

ชุดข้อมูลไฟล์แนบของซองจดหมาย ลำดับการแสดงผลคือลำดับการเพิ่มเอกสาร

 

fileKey 

string

false

fileKey ของเอกสาร

signerInfos

array

true

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

 

businessId

string

false

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

 deliveryMethods

string

false

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

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

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

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

sms- ส่ง SMS แจ้งเตือน

WhatsApp- ส่ง WhatsApp แจ้งเตือน

 

userEmail

string

false

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

 

userName

string

true

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

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

 

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-การตรวจสอบ OTP ทาง SMS

idVerification-การตรวจสอบเอกสารประจำตัว

emailAuth-การตรวจสอบ OTP ทางอีเมล

digitalId-การตรวจสอบข้อมูลประจำตัวทางอิเล็กทรอนิกส์

whatsappAuth-การตรวจสอบ OTP ทาง WhatsApp

 

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- ใช้ 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

การตรวจสอบ WhatsApp OTP จำเป็นต้องกรอกเมื่อ 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-คอนโทรลการอนุมัติ

   

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

 

 

 

posX

float

false

พิกัดแกน x

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

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

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

 

 

 

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

มีผลกับข้อความเท่านั้น ค่าเริ่มต้นคือ 1

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

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

 

 

 

 

minFontSize

float

false

มีผลกับข้อความเท่านั้น มีผลกับ 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

มีผลกับข้อความเท่านั้น แบบอักษร ค่าเริ่มต้นคือ宋体

1-宋体

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

 

 

 

 

fontSize

float

false

มีผลกับข้อความเท่านั้น ขนาดตัวอักษร ค่าเริ่มต้นคือ 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

มีผลกับข้อความเท่านั้น สีฐานสิบหก ค่าเริ่มต้นคือสีดำ #000

 

 

 

 

bold

boolean

false

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

จริง - ตัวหนา

เท็จ - ไม่ตัวหนา

 

 

 

 

italic

boolean

false

ใช้ได้เฉพาะกับข้อความเท่านั้น ตัวเอียงหรือไม่ ค่าเริ่มต้นคือเท็จ

จริง - ตัวเอียง

เท็จ - ไม่เอียง

 

 

 

 

underline

boolean

false

ใช้ได้เฉพาะกับข้อความเท่านั้น ขีดเส้นใต้ข้อความหรือไม่ ค่าเริ่มต้นคือเท็จ

จริง - เพิ่มเส้นใต้

เท็จ - ไม่เพิ่มเส้นใต้

 

 

 

 

lineThrough

boolean

false

ใช้ได้เฉพาะกับข้อความเท่านั้น เพิ่มเส้นทับหรือไม่ ค่าเริ่มต้นคือเท็จ

จริง - เพิ่มเส้นทับ

เท็จ - ไม่เพิ่มเส้นทับ

 

 

 

 

horizontalAlignment

string

false

ใช้ได้เฉพาะกับข้อความเท่านั้น รูปแบบจัดกึ่งกลางแนวนอน ค่าเริ่มต้นคือซ้าย

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

MM dd yyyy

dd MM 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

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

 

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"
}