Tambah Penandatangan

Nama Parameter

Jenis

Wajib

Keterangan

envelopeId

string

true

ID Sampul

signerInfos

array

true

Maklumat penandatangan

businessId

string

false

Nombor rujuk perniagaan yang ditetapkan oleh pembangun, panjang maksimum 500

roleTypes

array

false

Kaedah operasi penandatangan, nilai lalai ialah ["sign", "fill"]

fill-isi

sign-tandatangan

string

false

userEmail

string

false

Alamat e-mel penandatangan

documentVisibility

object

false

Konfigurasi keterlihatan fail, secara lalai semua boleh dilihat.

documentViewType

string

false

Strategi keterlihatan, secara lalai all; all bermaksud semua fail tandatangan dalam sampul boleh dilihat, limited bermaksud hanya fail tandatangan sendiri dan fail tambahan yang boleh dilihat boleh dilihat.

viewableFileKeys

array

false

Senarai fileKey tambahan yang dibenarkan untuk ditonton oleh penandatangan; hanya dibenarkan dihantar dan berkesan apabila documentViewType=limited.

phoneNumber

object

false

Wajib diisi apabila pemberitahuan SMS diperlukan, countryCode dan number perlu dihantar sebagai parameter, secara lalai kosong

countryCode

string

false

Kod antarabangsa negara/daerah, tiada keperluan untuk memasukkan "+"

number

string

false

Tiada pengesahan format, panjang maksimum 13 digit

customizeSettings

object

false

Konfigurasi tersuai

notificationSettings

object

false

Konfigurasi tersuai jenis pemberitahuan

customizeMessage

string

false

Pemberitahuan mesej eksklusif, had aksara 200

notificationLanguage

string

false

Bahasa pemberitahuan, secara lalai mengambil konfigurasi "bahasa pemberitahuan lalai"

en-US Bahasa Inggeris

zh-CN Cina Simplifikasi

zh-Hant Cina Tradisional

ja-JP Bahasa Jepun

es-MX Bahasa Sepanyol

pt-PT Bahasa Portugis
th-TH Bahasa Thai
id-ID Bahasa Indonesia
vi-VN Bahasa Vietnam
ms-MY Bahasa Melayu
fil-PH Bahasa Filipina
de-DE Bahasa Jerman
fr-FR Bahasa Perancis
ru-RU Bahasa Rusia
it-IT Bahasa Itali
ko-KR Bahasa Korea

userName

string

true

Nama penandatangan, digunakan untuk memaparkan nama penandatangan pada halaman dan alur kerja penandatanganan.

[Perhatian] Tidak boleh mengandungi 9 aksara khas berikut: / \ : * " < > | ? serta semua emoji

signOrder

int

true

Susunan penandatanganan penandatangan, minimum ialah 1. Untuk penandatanganan tanpa urutan, nilai urutan yang sama boleh ditetapkan.

signTaskSuspend

boolean

false

Adakah nod halangan aliran ditetapkan sebelum lokasi penandatanganan ini, secara lalai false. true- tetapkan nod halangan; false- tidak tetapkan nod halangan. Konfigurasi halangan dalam kumpulan atau-tanda tangan dengan signOrder yang sama mesti konsisten.

suspensionKey

string

false

Pengenal pasti nod halangan, maksimum 500 aksara, unik dalam sampul yang sama. Wajib diisi apabila signTaskSuspend=true; tidak boleh dimasukkan apabila signTaskSuspend=false atau tidak dihantar.

suspendReason

string

false

Sebab halangan, tidak boleh kosong apabila dihantar, maksimum 50 aksara. Hanya boleh dihantar apabila signTaskSuspend=true; jika tidak dihantar, secara lalai menunjukkan perlu menunggu pemprosesan oleh sistem luaran. Tidak boleh dimasukkan apabila signTaskSuspend=false atau tidak dihantar.

anySigner

boolean

false

Adakah sokongan untuk sesiapa sahaja menandatangani, secara lalai false

true- hanya salah seorang daripada mereka dalam signOrder yang sama perlu menandatangani

false- semua orang dalam signOrder yang sama perlu menandatangani

authModes

string

false

Kaedah pengesahan identiti, secara lalai noAuth

Jenis enum:

authConfig

object

false

Tetapan kaedah pengesahan

accessCode

object

false

Tetapan kata laluan tandatangan, apabila authModes=accessCodewajib diisi

accessCode

string

false

Kandungan kata laluan, tidak membezakan huruf besar dan kecil, boleh mengandungi huruf dan nombor, panjang maksimum 45

promptInfo

string

false

Mesej panduan kata laluan akses, tidak boleh mengandungi kata laluan akses, had panjang 30, apabila authModes=accessCodewajib diisi.

sms

object

false

Pengesahan OTP SMS, apabila authModes=smswajib diisi

countryCode

string

false

Kod antarabangsa negara/daerah, tanpa tanda “+”

number

string

false

Tiada semakan format, panjang maksimum 13 digit

idVerification

object

false

Tetapan pengesahan dokumen pengenalan, apabila authModes=idVerificationwajib diisi

name

string

false

Nama penuh pada dokumen pengenalan penandatangan, panjang maksimum 100 aksara

emailAuth

object

false

Pengesahan OTP e-mel, apabila authModes=emailAuthwajib diisi

authEmail

string

false

Alamat e-mel pengesahan identiti penandatangan

digitalId

array

false

Pengesahan identiti elektronik, diperlukan apabila authModes=digitalId

authApp

string

false

Aplikasi yang digunakan untuk pengesahan identiti elektronik

singpass-Gunakan Singpass untuk pengesahan identiti

iamsmart-Gunakan MySejahtera untuk pengesahan identiti

idNumber

string

false

Nombor dokumen pengenalan diri penandatangan yang perlu disahkan

Apabila authApp=singpassperaturan input ialah: huruf besar + 7 atau 8 digit nombor + huruf besar

Apabila authApp=iamsmartperaturan input ialah:

1. Satu huruf besar (A-Z), atau dua huruf besar (AA-ZZ), sebagai permulaan siri;

2. Seterusnya diikuti oleh 6 digit nombor;

3. Akhir sekali ialah kod semak, boleh berupa nombor (0-9) atau huruf (A-Z). Contoh: A888888(A)

whatsappAuth

object

false

Pengesahan OTP WhatsApp, diperlukan apabila authModes=whatsappAuth

countryCode

string

false

Kod antarabangsa negara/daerah, tidak perlu memasukkan "+"

number

string

false

Tidak melakukan pengesahan format, hanya hadkan panjang maksimum kepada 13 digit

digitalSignature

boolean

false

Adakah tanda tangan digital diaktifkan, nilai lalai false

true-Diaktifkan

false-Tidak diaktifkan

tsp

string

false

Pilih TSP yang digunakan oleh penandatangan, nilai lalai false.

Jika tidak ditetapkan, penandatangan akan memilih sendiri TSP yang diperlukan. Senarai termasuk:

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

Adakah penandatangan bebas menggunakan cap, nilai lalai false

Penjelasan tambahan:

Apabila freeFormSign dipilih sebagai true, parameter lain di bawah sealInfos tidak perlu dimasukkan. Jika dimasukkan serentak, keutamaan freeFormSign lebih tinggi daripada sealInfos, dan parameter di bawah sealInfos tidak akan berkesan.

[Perhatian] Tanda tangan bebas bermaksud tidak hadkan bilangan dan kedudukan cap/tanda tangan yang boleh diseret oleh penandatangan.

sealInfos

array

false

Maklumat tugas penandatanganan

fileKey

string

true

fileKey fail penandatanganan

signConfigs

array

false

Maklumat kedudukan kawalan, maklumat kedudukan kawalan mesti ditentukan untuk melaksanakan tanda tangan elektronik.

fieldType

string

false

Jenis kawalan, parameter input boleh:

signature-Kawalan tanda tangan

stamp-Kawalan cap

Lalai kepada signature

Adakah ia diperlukan, secara lalai diperlukan

true-Diperlukan

false-Tidak diperlukan

signFieldStyle

string

false

Kaedah penempatan kawalan tandatangan, secara lalai normalSeal.

normalSeal-Cap tandatangan biasa

pagingSeal-Cap halaman bersebelahan

Hanya kawalan tandatangan dan kawalan cap menyokong tetapan cap halaman bersebelahan.

pagingSealMode

string

false

Julat halaman untuk penempatan cap halaman bersebelahan, secara lalai all.

all-Semua nombor halaman

assignedPages-Nombor halaman tertentu

even-Halaman genap

odd-Halaman ganjil

Hanya disokong untuk dinyatakan apabila signFieldStyle=pagingSeal.

sizeRule

string

false

Cara paparan saiz kawasan tandatangan

originalSize- Letakkan cap mengikut saiz sebenar tandatangan/cap

targetSize- Lebar dan tinggi kawasan tandatangan/cap yang disesuaikan

Apabila sizeRule, height, width semuanya kosong, cap diletakkan mengikut saiz sebenar tandatangan/cap;

Apabila sizeRule kosong tetapi height dan width tidak kosong, cap diletakkan mengikut saiz yang ditentukan;

Apabila sizeRule tidak kosong, cap diletakkan mengikut cara paparan yang ditentukan;

Cap merentas halaman tidak memerlukan parameter ini ditetapkan, ia hanya diletakkan mengikut saiz sebenar.

height

int

false

Ketinggian alat kawalan tandatangan, sesuai untuk fieldType signature/stamp, dalam unit px, hanya menyokong integer positif, lalai auto (iaitu saiz automatik sistem);

Apabila fieldType=signature, julat tetapan ialah 20-250px;

Apabila fieldType=stamp, julat tetapan ialah 30-280px;

Cap merentas halaman tidak memerlukan parameter ini ditetapkan.

width

int

false

Lebar alat kawalan tandatangan, sesuai untuk fieldType signature/stamp, dalam unit px, hanya menyokong integer positif, lalai auto (iaitu saiz automatik sistem);

Apabila fieldType=signature, julat tetapan ialah 20-250px;

Apabila fieldType=stamp, julat tetapan ialah 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，则坐标位置指签名区bawah kiri；

Jika fieldType ialah stamp, kedudukan koordinat merujuk kepada kawasan cap.titik tengahkedudukan

Sejak 3 Februari 2026, jika fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap.

Cap berpotongan boleh dihantar sebagai 0, tidak boleh dihantar sebagai null; widget ditetapkan pada tepi kanan fail.

posY

string

false

koordinat paksi-Y

Nota tambahan:

Jika fieldType ialah signature, kedudukan koordinat merujuk kepada kawasan tandatangan.bawah kiri；

Jika fieldType ialah stamp, kedudukan koordinat merujuk kepada kawasan cap.titik tengahkedudukan

Sejak 3 Februari 2026, jika fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap.

fillConfigs

array

false

Isi maklumat widget

fieldName

string

false

Nama kawalan, had 128 aksara

required

boolean

false

Adakah diperlukan, secara lalai diperlukan

true-diperlukan

false-tidak diperlukan

fieldType

string

false

Jenis kawalan:

1-teks satu baris

15-kotak semak

textField

object

false

Atribut kawalan teks

overflowType

int

false

Hanya berkesan untuk text, secara lalai 1

1-secara automatik mengecilkan saiz fon

2-menghadkan input

minFontSize

float

false

Hanya berkesan untuk text, hanya berkesan apabila overflowType=1, secara lalai 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

Lebar kawalan, secara lalai 160px

font

int

false

Hanya berkesan untuk text, fon, secara lalai Songti.

1-Songti

2-Songti Baru

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-Fangsong

11-Georgia

12-Monospace

fontSize

float

false

Hanya berkuat untuk text, saiz fon, lalai 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

Hanya berkuat untuk text, warna heksadesimal, lalai hitam #000

bold

boolean

false

Hanya berkuat untuk text, sama ada fon ditebalkan atau tidak, lalai false

true-ditebalkan

false-tidak ditebalkan

italic

boolean

false

Hanya berkuat untuk text, sama ada miring atau tidak, lalai false

true-miring

false-tidak miring

underline

boolean

false

Hanya berkuat untuk text, sama ada garis bawah ditambahkan pada fon atau tidak, lalai false

true-garis bawah ditambahkan

false-garis bawah tidak ditambahkan

lineThrough

boolean

false

Hanya berkuat untuk text, sama ada menambahkan coretan atau tidak, lalai false

true-menyatakan coretan

false-tidak menambahkan coretan

horizontalAlignment

string

false

Hanya berkuat untuk text, format tengah mendatar, lalai left

LEFT-kiri

CENTER-tengah

RIGHT-kanan

tickBoxField

object

false

Atribut kotak semak

tickOptions

array

false

Hanya berkuat untuk Check, lalai 1

1-tanda

2-silang

posX

float

false

Koordinat X kedudukan kawalan

posY

float

false

Koordinat Y kedudukan kawalan

pageNo

string

false

Nombor halaman tempat kawalan berada

signDateConfigs

array

false

Maklumat lokasi tarikh tandatangan

movable

boolean

false

Membolehkan pergerakan semasa penandatanganan, nilai asal false

false- Penandatangan tidak dibenarkan menyesuaikan kedudukan alat kawalan penandatanganan sendiri

true- Penandatangan dibenarkan menyesuaikan kedudukan alat kawalan penandatanganan sendiri

pageNo

string

false

Nombor halaman penandatanganan; halaman berturut-turut disambungkan dengan "-", halaman tunggal dipisahkan dengan ",", contohnya: 1-3, 6-10

Jika tidak berturut-turut, gunakan "," untuk pemisahan

posX

float

false

Anjakan paksi-x, titik asal koordinat ialah sudut kiri bawah halaman

posY

float

false

Anjakan paksi-y, titik asal koordinat ialah sudut kiri bawah halaman

signDateFormat

string

false

Format tarikh penandatanganan, format asal ialah yyyy-MM-dd

Format yang disokong:

Tahun MM Bulan dd Hari

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy