Nama Parameter | Jenis | Wajib | Keterangan |
subject | string | true | Tema Envelope Contoh: "Surat Tawaran" |
remark | string | false | Nota envelope, had panjang 1000 aksara |
signerSettings | object | false | Tindakan yang dibenarkan kepada penandatangan |
| | allowTransfer | boolean | false | Adakah penandatangan dibenarkan menyerahkan sampul ini kepada orang lain untuk ditandatangani, lalai false true - membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan sampul tersebut kepada orang lain; false - tidak membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan sampul tersebut kepada orang lain; |
| | allowModifyName | boolean | false | Adakah pihak penandatangan dibenarkan mengubah nama, hanya berkuat kuasa untuk tandatangan templat, lalai false true - membenarkan penandatangan mengubah nama false - tidak membenarkan penandatangan mengubah nama |
expireAfterSeconds | long | false | Masa luput sampul, berapa saat selepas itu sampul akan luput Julat luput: 86,400 saat (1 hari) ~ 7,776,000 saat (90 hari) |
redirectUrl | string | false | Perlu menjadi alamat https yang sah |
callBackUrl | string | false | Alamat panggilan balik (panjang 500), perlu mematuhi alamat protokol https. |
sendLaterAfterSeconds | long | false | Menyokong kelewatan penghantaran pengguna, dalam unit saat Julat masa yang disokong: 3600 saat (1 jam) ~ 259200 saat (30 hari) |
autoFinish | boolean | false | Mengawal sama ada sampul berakhir secara automatik, lalai true true- Sampul berakhir secara automatik false- Sampul berakhir secara manual |
CCInfos | array | false | Kumpulan maklumat CC |
| userEmail | string | false | Alamat e-mel CC |
| userName | string | false | Nama CC, digunakan untuk memaparkan nama CC pada halaman tandatangan dan sampul. [Perhatian]: Tidak boleh mengandungi 9 aksara khas berikut: / \ : * " < > | ? serta semua emoji |
| ccOrder | int | false | Posisi urutan CC dalam proses tandatangan, berkongsi urutan dengan signOrder penandatangan. Jika tidak dihantar, logik pemberitahuan CC asal akan digunakan. |
| | customizeSettings | object | false | Konfigurasi tersuai |
| | | notificationSettings | object | false | Konfigurasi tersuai jenis pemberitahuan |
| | | | notificationLanguage | string | false | Bahasa pemberitahuan, secara lalai mengambil konfigurasi "Bahasa pemberitahuan lalai" en-US Bahasa Inggeris zh-CN Bahasa Cina Simplified zh-Hant Bahasa 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 |
signFiles | array | true | Kumpulan maklumat dokumen yang ditandatangani, susunan dipaparkan mengikut urutan penambahan dokumen. |
| fileKey | string | true | fileKey dokumen yang ditandatangani, hanya menyokong format PDF |
| | documentFields | array | false | Senarai kawalan dimensi dokumen. Digunakan untuk menambah kawalan dimensi dokumen pada dokumen tertentu tanpa dikaitkan dengan penandatangan. |
| | fieldType | string | false | Jenis kawalan. Hantar eMeterai untuk menunjukkan kawalan cukai meterai Indonesia. |
| | pageNo | string | false | Nombor halaman di mana kawalan berada. Kawalan cukai meterai Indonesia hanya menyokong penetapan satu halaman tunggal, perlu menghantar nombor halaman tunggal, tidak menyokong format berbilang halaman berterusan atau tidak berterusan seperti 1-3, 1,3. |
| | | posX | float | false | Anjakan paksi-x, titik asal koordinat adalah sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain. |
| | | posY | float | false | Pengecakan paksi-y, dengan asalan koordinat di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain. |
attachments | array | false | Kumpulan lampiran sampul surat, susunan paparannya mengikut urutan fail yang ditambah. |
| fileKey | string | false | fileKey fail |
signerInfos | array | true | Kumpulan maklumat penandatangan |
| businessId | string | false | Nombor perniagaan tersuai oleh pembangun, had panjang 500 |
| | roleTypes | array | false | Cara operasi penandatangan, nilai lalai ialah ["sign", "fill"] fill-isian sign-tandatangan |
| | deliveryMethods | string | false | Kaedah pemberitahuan, lalai auto auto-hantar pemberitahuan e-mel apabila userEmail dipindahkan, hantar pemberitahuan SMS apabila phoneNumber dipindahkan none-tidak menghantar pemberitahuan mesej email-menghantar pemberitahuan e-mel sms-menghantar pemberitahuan SMS WhatsApp-menghantar pemberitahuan WhatsApp |
| userEmail | string | false | Alamat e-mel penandatangan |
| userName | string | true | Nama penandatangan, digunakan untuk memaparkan nama penandatangan pada halaman tandatangan dan sampul. [Nota] Tidak boleh mengandungi 9 aksara khas berikut: / \ : * " < > | ? serta semua emoji |
| | minimumReadingDuration | int | false | Tetapkan masa undur bacaan wajib pada halaman tetapan, nilai asal ialah 0 (unit: saat, maksimum 999) 0 atau tidak dihantar menunjukkan tidak diaktifkan, tiada undur bacaan diperlukan |
| | readToEndRequired | boolean | false | Menunjukkan sama ada mesti dibaca sehingga akhir. Lalai false; true menunjukkan diaktifkan, false atau tidak dihantar menunjukkan tidak diaktifkan. |
| phoneNumber | object | false | Nombor telefon, lalai kosong Parameter wajib apabila pemberitahuan SMS diperlukan, countryCode dan number perlu dihantar |
| | countryCode | string | false | Kod antarabangsa negara/daerah, tidak perlu menghantar "+" |
| | number | string | false | Tiada pengesahan format, hanya had panjang maksimum kepada 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, lalai mengambil konfigurasi "bahasa pemberitahuan lalai" en-US Bahasa Inggeris zh-CN Bahasa Cina Ringkas zh-Hant Bahasa 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 |
| signOrder | int | true | Susunan tandatangan penandatangan, nilai minimum ialah 1. Tandatangan tanpa susunan boleh menetapkan nilai susunan yang sama. |
| signTaskSuspend | boolean | false | Adakah nod halangan aliran kerja ditetapkan sebelum lokasi tandatangan ini, nilai lalai false. true- tetapkan nod halangan; false- tidak tetapkan nod halangan. Konfigurasi halangan dalam kumpulan tandatangan atau dengan signOrder yang sama mesti konsisten. |
| suspensionKey | string | false | Pengenal pasti nod halangan, maksimum 500 aksara, unik dalam sampul surat yang sama. Wajib diisi apabila signTaskSuspend=true; tidak boleh dihantar 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 bermaksud perlu menunggu pemprosesan oleh sistem luaran. Tidak boleh dihantar apabila signTaskSuspend=false atau tidak dihantar. |
| anySigner | boolean | false | Adakah menyokong sesiapa sahaja untuk menandatangani, nilai lalai false true- Hanya salah seorang daripada signOrder yang sama perlu menandatangani false- Semua orang dalam signOrder yang sama perlu menandatangani |
| authModes | string | false | Kaedah pengesahan, nilai lalai noAuth noAuth- Tiada pengesahan accessCode- Pengesahan menggunakan kata laluan tandatangan sms- Pengesahan OTP SMS idVerification- Pengesahan dokumen pengenalan diri emailAuth- Pengesahan OTP e-mel digitalId- Pengesahan identiti elektronik whatsappAuth- Pengesahan OTP WhatsApp |
| authConfig | object | false | Tetapan Kaedah Pengesahan |
| | accessCode | object | false | Tetapan Kata Laluan Penandatanganan, diperlukan apabila authModes=accessCode |
| | | accessCode | string | false | Kandungan kata laluan, tidak membezakan huruf besar dan kecil, boleh mengandungi huruf dan nombor, had panjang 45 |
| | | | promptInfo | string | false | Mesej panduan kata laluan akses, tidak boleh mengandungi kata laluan akses, had panjang 30, diperlukan apabila authModes=accessCode |
| | sms | object | false | Pengesahan OTP SMS, diperlukan apabila authModes=sms |
| | | countryCode | string | false | Kod antarabangsa negara/daerah, tiada keperluan untuk memasukkan "+" |
| | | number | string | false | Tiada pengesahan format, hanya hadkan panjang maksimum kepada 13 digit |
| | idVerification | object | false | Tetapan Pengesahan Dokumen Pengenalan, diperlukan apabila authModes=idVerification |
| | | name | string | false | Nama penuh pada dokumen pengenalan penandatangan, panjang maksimum 100 aksara |
| | | emailAuth | object | false | Pengesahan OTP e-mel, diperlukan apabila authModes=emailAuth |
| | | | 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 i AM Smart untuk pengesahan identiti |
| | | idNumber | string | false | Nombor dokumen pengenalan diri penandatangan yang perlu disahkan Apabila authApp=singpass, peraturan input ialah: huruf besar+7 atau 8 digit nombor+huruf besar Apabila authApp=iamsmart, peraturan input ialah: 1. Satu huruf besar (A-Z), atau dua huruf besar (AA-ZZ), sebagai permulaan siri; 2. Seterusnya adalah 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 penandatanganan digital diaktifkan, nilai lalai false true-aktifkan, false-tidak aktifkan |
| 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 tandatangan, 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 berkuat kuasa [Perhatian]Cap tandatangan bebas bermaksud tiada had terhadap bilangan cap/tandatangan yang boleh diseret masuk oleh penandatangan serta kedudukannya |
| documentVisibility | object | false | Konfigurasi kebolehlihatan fail, semua boleh dilihat secara lalai. |
| | documentViewType | string | false | Strategi kebolehlihatan, nilai lalai all; all bermaksud semua dokumen penandatanganan dalam sampul boleh dilihat, limited bermaksud hanya dokumen penandatanganan sendiri dan dokumen tambahan yang boleh dilihat boleh diakses. |
| | viewableFileKeys | array | false | Senarai fileKey tambahan yang dibenarkan untuk dilihat oleh pihak penandatangan; hanya dibenarkan dimasukkan dan berkuat kuasa apabila documentViewType=limited. |
| sealInfos | array | false | Maklumat tugas penandatanganan |
| | fileKey | string | true | fileKey dokumen penandatanganan |
| | signConfigs | array | false | Maklumat kedudukan kawalan, maklumat kedudukan kawalan mesti ditetapkan untuk menandatangani secara elektronik. |
| | | fieldType | string | false | Jenis kawalan, lalai kepada signature signature-Kawalan tandatangan stamp-Kawalan cap approval-Kawalan kelulusan |
| | | | required | boolean | false | Adakah ia diperlukan, lalai diperlukan true-Diperlukan false-Tidak diperlukan |
| | | | signFieldStyle | string | false | Kaedah penempatan cap untuk kawalan penandatanganan, lalai kepada normalSeal. normalSeal-Cap tandatangan biasa pagingSeal-Cap rentas halaman Hanya kawalan tandatangan dan kawalan cap menyokong tetapan cap rentas halaman. |
| | | | pagingSealMode | string | false | Julat halaman untuk penempatan cap rentas halaman, lalai kepada all. all-Semua nombor halaman assignedPages-Nombor halaman tertentu even-Laman genap odd-Laman ganjil Hanya disokong untuk ditentukan apabila signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Cara paparan saiz kawasan tandatangan originalSize-Letak cap mengikut saiz sebenar tandatangan/cap targetSize-Tentukan lebar dan tinggi kawasan tandatangan/cap secara tersuai Apabila sizeRule, height, width semuanya kosong, letakkan cap mengikut saiz sebenar tandatangan/cap; Apabila sizeRule kosong tetapi height dan width tidak kosong, letakkan cap mengikut saiz yang ditetapkan; Apabila sizeRule tidak kosong, letakkan cap mengikut cara paparan yang ditetapkan; Cap merentas halaman tidak memerlukan parameter ini, hanya letakkan cap mengikut saiz sebenar. |
| | | height | int | false | Ketinggian kawalan tandatangan, sesuai untuk fieldType signature/stamp, unit dalam px, hanya menyokong integer positif, lalai auto (iaitu saiz automatik sistem); Apabila fieldType=signature, julat yang boleh ditetapkan ialah 20-250px; Apabila fieldType=stamp, julat yang boleh ditetapkan ialah 30-280px; Cap merentas halaman tidak memerlukan parameter ini. |
| | | width | int | false | Lebar kawalan tandatangan, sesuai untuk fieldType signature/stamp, unit dalam px, hanya menyokong integer positif, lalai auto (iaitu saiz automatik sistem); Apabila fieldType=signature, julat boleh ditetapkan antara 20-250px; Apabila fieldType=stamp, julat boleh ditetapkan antara 30-280px; Cap bersepadu tidak memerlukan parameter ini untuk ditentukan. |
| | | signatureOptions | string | false | Pilihan widget tandatangan. Hanya terpakai apabila fieldType ialah signature Parameter yang boleh dimasukkan: template: Tandatangan templat handDrawn: Tandatangan lukisan tangan upload: Muat naik imej tandatangan tempatan aiHandDrawn: Tandatangan tulisan tangan AI Boleh memilih lebih daripada satu, dipisahkan dengan ",", secara lalai semua dipilih |
| | | movable | boolean | false | Membolehkan kedudukan dialihkan semasa penandatangan, secara lalai false false-Tidak membenarkan penandatangan menyesuaikan kedudukan widget tandatangan mereka true-Membenarkan penandatangan menyesuaikan kedudukan widget tandatangan mereka |
| | | allowedOptions | array | false | Pilihan yang membolehkan penandatangan meluluskan, terpakai apabila fieldType ialah approval. Secara lalai ["approve", "decline"] approve-Setuju decline-Tolak |
| | | pageNo | string | false | Nombor halaman tandatangan; gunakan "-" untuk menyambungkan nombor halaman berturutan, dan "," untuk memisahkan nombor halaman yang berasingan Contoh: 1-3,6-10 Hantar julat halaman tempat cap jalinan diletakkan apabila pagingSealMode=assignedPages. Cap jalinan hanya boleh digunakan untuk fail yang mempunyai lebih daripada 1 halaman. |
| | | posX | float | false | Koordinat paksi-x [Perhatian] Jika fieldType ialah signature, kedudukan koordinat merujuk kepada kawasan tandatanganBawah kiri; Jika fieldType ialah stamp, kedudukan koordinat merujuk kepada kawasan capTitik tengahKedudukan Mulai 3 Februari 2026, jika fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap. Nilai untuk cap jalinan boleh dihantar sebagai 0, tetapi tidak boleh null; komponen akan tetap pada tepi kanan fail. |
| | | posY | float | false | Koordinat paksi-y [Perhatian] Jika fieldType ialah signature, kedudukan koordinat merujuk kepada kawasan tandatanganBawah kiri; Jika fieldType ialah stamp, kedudukan koordinat merujuk kepada kawasan capTitik tengahKedudukan Bermula dari 3 Februari 2026, jika fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap. |
| | fillConfigs | array | false | Isi maklumat kawalan |
| | | fieldName | string | false | Nama kawalan, had karakter 128 |
| | | required | boolean | false | Wajib diisi, secara lalai wajib diisi true-wajib diisi false-tidak wajib diisi |
| | | fieldType | string | false | Jenis kawalan: 1-teks satu baris 15-kotak centang |
| | | textField | object | false | Atribut kawalan teks |
| | | | overflowType | int | false | Hanya berkesan untuk text, secara lalai 1 1-kecilkan saiz fon secara automatik 2-Batasi input |
| | | | minFontSize | float | false | Hanya berkesan untuk text, hanya berkesan untuk overflowType=1, 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, lalai 160px |
| | | | font | int | false | Hanya berkesan untuk text, fon, lalai Songti 1-Songti 2-Xin Songti 4-Heiti 5-Kaiti 6-Arial 7-Helvetica 9-Times New Roman 10-Fangsong 11-Georgia 12-Monospace |
| | | | fontSize | float | false | Hanya berkesan 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 berkesan untuk text, warna heksadesimal, lalai hitam #000 |
| | | | bold | boolean | false | Hanya berkesan untuk text, sama ada fon ditebalkan atau tidak, lalai false true-Ditebalkan false-Tidak ditebalkan |
| | | | italic | boolean | false | Hanya berkesan untuk text, sama ada miring atau tidak, lalai false true-Condong false-Bukan Condong |
| | | | underline | boolean | false | Hanya berkesan 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 berkesan untuk text, sama ada garis coretan ditambahkan atau tidak, lalai false true-Garis coretan ditambahkan false-Garis coretan tidak ditambahkan |
| | | | horizontalAlignment | string | false | Hanya berkesan untuk text, format tengah mendatar, lalai left LEFT-Kiri CENTER-Tengah RIGHT-Kanan |
| | | tickBoxField | object | false | Atribut kotak semak |
| | | | tickOptions | array | false | Hanya berkesan untuk tickBox, lalai 1 1-Cek 2-cabang |
| | | 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 posisi semasa penandatanganan, nilai lalai false false-Penandatangan tidak dibenarkan menyesuaikan posisi alat kawalan tandangannya sendiri true-Penandatangan dibenarkan menyesuaikan posisi alat kawalan tandangannya sendiri |
| | | pageNo | string | false | Nombor halaman tandatangan; halaman berturut-turut disambungkan dengan "-", halaman tunggal dipisahkan dengan ",", contoh: 1-3, 6-10; Jika tidak berturut-turut, gunakan "," untuk pemisahan. |
| | | posX | float | false | Anjakan paksi-x, titik asal koordinat di sudut kiri bawah halaman |
| | | posY | float | false | Anjakan paksi-y, titik asal koordinat di sudut kiri bawah halaman |
| | | signDateFormat | string | false | Format tarikh tandatangan, format lalai yyyy-MM-dd Menyokong format yang ditetapkan: Tahun yyyy Bulan MM Hari dd yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |