Nama Parameter | Jenis | Wajib | Keterangan |
subject | string | true | Tajuk Sampul Surat Contoh: "Surat Tawaran" |
remark | string | false | Nota sampul surat, had panjang 1000 aksara |
signerSettings | object | false | Tindakan yang dibenarkan kepada penandatangan |
| | allowTransfer | boolean | false | Adakah penandatangan dibenarkan untuk menyerahkan sampul ini kepada orang lain untuk ditandatangani, nilai 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, nilai 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 penghantaran lewat oleh 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, nilai lalai true true- Sampul berakhir secara automatik false- Sampul berakhir secara manual |
CCInfos | array | false | Koleksi maklumat penerima salinan |
| userEmail | string | false | Alamat e-mel penerima salinan |
| userName | string | false | Nama penerima salinan, digunakan untuk memaparkan nama penerima salinan pada halaman tandatangan dan sampul surat. [Perhatian]: Tidak boleh mengandungi 9 aksara istimewa berikut: / \ : * " < > | ? serta semua emoji |
| | 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 tandatangan, susunan dipaparkan mengikut urutan penambahan dokumen. |
| fileKey | string | true | fileKey dokumen tandatangan, 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 tempat kawalan berada. Kawalan cukai meterai Indonesia hanya menyokong penetapan 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 di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain. |
| | | posY | float | false | Anjakan paksi-y, titik asal koordinat adalah di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain. |
attachments | array | false | Set lampiran sampul, susunan papar mengikut urutan penambahan fail. |
| fileKey | string | false | fileKey fail |
signerInfos | array | true | Set maklumat penandatangan |
| businessId | string | false | Nombor perniagaan tersuai pembangun, had panjang 500 |
| | roleTypes | array | false | Kaedah operasi penandatangan, nilai lalai ialah ["sign", "fill"] fill-isi sign-tandatangani |
| | 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-hantar pemberitahuan e-mel sms-hantar pemberitahuan SMS WhatsApp-hantar pemberitahuan WhatsApp |
| userEmail | string | false | Alamat e-mel penandatangan |
| userName | string | true | Nama penandatangan, digunakan untuk memaparkan nama penandatangan pada halaman tandatangan dan luaran sampul. [Nota] Tidak boleh mengandungi 9 aksara khas berikut: / \ : * " < > | ? serta semua emoji |
| | minimumReadingDuration | int | false | Tetapkan masa undur bacaan paksa pada halaman tetapan, nilai lalai ialah 0 (unit: saat, maksimum 999) 0 atau tidak dihantar menunjukkan tidak diaktifkan, tiada undur masa bacaan diperlukan |
| | readToEndRequired | boolean | false | Menunjukkan sama ada mesti dibaca hingga akhir. Nilai lalai false; true menunjukkan diaktifkan, false atau tidak dihantar menunjukkan tidak diaktifkan. |
| phoneNumber | object | false | Nombor telefon, kosong secara lalai Parameter wajib apabila pemberitahuan SMS diperlukan, countryCode dan number perlu dihantar |
| | countryCode | string | false | Kod antarabangsa untuk negara/daerah, tidak perlu menghantar "+" |
| | number | string | false | Tiada pengesahan format, hanya hadkan 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, ambil secara lalai dari konfigurasi "Bahasa Pemberitahuan Lalai" en-US Bahasa Inggeris zh-CN Cina Simplified 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 |
| signOrder | int | true | Susunan tandatangan penandatangan, minimum ialah 1. Tandatangan tanpa susunan boleh menetapkan nilai urutan yang sama. |
| anySigner | boolean | false | Sokongkah tandatangan oleh sesiapa sahaja, lalai false true-Hanya perlu satu daripada pihak yang sama signOrder untuk menandatangani false-Semua pihak dalam signOrder yang sama mesti menandatangani |
| authModes | string | false | Kaedah pengesahan, lalai noAuth noAuth-Tidak disahkan accessCode-Disahkan menggunakan kata laluan tandatangan sms-Pengesahan OTP SMS idVerification-Pengesahan dokumen pengenalan 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 tandatangan, apabila authModes=accessCodewajib diisi |
| | | accessCode | string | false | Kandungan kata laluan, tidak membezakan huruf besar dan kecil, boleh mengandungi huruf dan nombor, had panjang 45 |
| | | | promptInfo | string | false | Mesej arahan 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 penandatangan yang menunggu pengesahan 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 | Tiada pengesahan format, hanya hadkan panjang maksimum kepada 13 digit |
| digitalSignature | boolean | false | Adakah tanda tangan digital diaktifkan, nilai default false true-diaaktifkan, false-tidak diaktifkan |
| freeFormSign | boolean | false | Adakah penandatangan dibenarkan menandatangani secara bebas, nilai default false Penjelasan tambahan: Apabila freeFormSign ditetapkan sebagai true, parameter lain di bawah sealInfos tidak perlu dimasukkan. Jika dimasukkan serentak, keutamaan freeFormSign adalah lebih tinggi daripada sealInfos, dan parameter di bawah sealInfos tidak akan berkesan. [Perhatian]Tandatangan bebas bermaksud tiada had terhadap bilangan dan kedudukan cap/tandatangan yang boleh diseret oleh penandatangan. |
| sealInfos | array | false | Maklumat tugasan tandatangan |
| | fileKey | string | true | fileKey fail tandatangan |
| | signConfigs | array | false | Maklumat kedudukan kawalan; maklumat kedudukan kawalan mesti ditentukan untuk melaksanakan tandatangan elektronik. |
| | | fieldType | string | false | Jenis kawalan, secara lalai ialah signature signature-Kawalan tandatangan stamp-Kawalan cap approval-Kawalan kelulusan |
| | | | required | boolean | false | Adakah ia diperlukan, secara lalai diperlukan true-Wajib diisi false-Tidak wajib diisi |
| | | | signFieldStyle | string | false | Cara peletakan kawalan tandatangan, secara lalai ialah normalSeal. normalSeal-Cap biasa pagingSeal-Cap merentas halaman Hanya widget tandatangan dan widget cap menyokong tetapan cap merentas halaman. |
| | | | pagingSealMode | string | false | Julat halaman untuk cap merentas halaman, lalai ialah all. all-Semua nombor halaman assignedPages-Nombor halaman tertentu even-Halaman genap odd-Halaman ganjil Hanya disokong apabila signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Cara paparan saiz kawasan tandatangan originalSize-Letak cap mengikut saiz sebenar tandatangan/cap targetSize-Tinggi dan lebar kawasan tandatangan/cap 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 ditentukan; Apabila sizeRule tidak kosong, letakkan cap mengikut cara paparan yang ditentukan; Cap jari tidak memerlukan parameter ini, hanya capkan berdasarkan 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 yang boleh ditetapkan ialah 20-250px; Apabila fieldType=stamp, julat yang boleh ditetapkan ialah 30-280px; Cap jari tidak memerlukan parameter ini. |
| | | 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 yang boleh ditetapkan ialah 20-250px; Apabila fieldType=stamp, julat yang boleh ditetapkan ialah 30-280px; Cap jari tidak memerlukan parameter ini. |
| | | signatureOptions | string | false | Pilihan alat kawalan tandatangan. Hanya sesuai untuk fieldType signature Parameter input: template: Tandatangan templat handDrawn: Tandatangan lukisan tangan upload: Muat naik imej tandatangan tempatan Boleh pilih berbilang, dipisahkan dengan ",", lalai semua dipilih |
| | | movable | boolean | false | Membolehkan pergerakan lokasi semasa penandatanganan, nilai lalai false false - Penandatangan tidak dibenarkan menyesuaikan kedudukan widget penandatanganan mereka sendiri true - Penandatangan dibenarkan menyesuaikan kedudukan widget penandatanganan mereka sendiri |
| | | allowedOptions | array | false | Pilihan yang membolehkan penandatangan meluluskan, sesuai untuk fieldType approval. Nilai lalai adalah ["approve", "decline"] approve- Setuju decline- Tolak |
| | | pageNo | string | false | Nombor halaman penandatanganan; halaman berturut-turut disambungkan dengan "-", halaman tunggal disambungkan dengan "," Contoh: 1-3,6-10 Masukkan julat halaman tempat cap jilid diletakkan apabila pagingSealMode=assignedPages. Cap jilid hanya boleh digunakan untuk fail yang mempunyai lebih daripada satu 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 Sejak 3 Februari 2026, apabila fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap. Nilai untuk cap bersempadan boleh dihantar sebagai 0, tidak boleh dihantar sebagai null; widget ditetapkan pada tepi kanan fail. |
| | | posY | float | false | Koordinat paksi-y 【Perhatian】Jika fieldType ialah signature, kedudukan koordinatnya merujuk kepada kawasan tandatanganBawah kiri; Jika fieldType ialah stamp, kedudukan koordinatnya merujuk kepada kawasan capTitik tengahKedudukan Sejak 3 Februari 2026, apabila fieldType ialah signature atau stamp, kedudukan koordinatnya merujuk kepada titik tengah kawasan cap. |
| | fillConfigs | array | false | Isi maklumat widget |
| | | fieldName | string | false | Nama widget, had panjang aksara 128 |
| | | required | boolean | false | Adakah wajib diisi, secara lalai wajib diisi true-wajib diisi false-tidak wajib diisi |
| | | fieldType | string | false | Jenis widget: 1-Teks Satu Baris 15-Kotak Semak |
| | | textField | object | false | Atribut Kawalan Teks |
| | | | overflowType | int | false | Hanya berkesan untuk teks, lalai 1 1-Susutkan saiz fon secara automatik 2-Batasi input |
| | | | minFontSize | float | false | Hanya berkesan untuk teks, hanya berkesan apabila 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 teks, 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 teks, 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 kuasa terhadap text, warna heksadesimal, hitam lalai #000 |
| | | | bold | boolean | false | Hanya berkuat kuasa terhadap text, sama ada fon ditebalkan atau tidak, lalai false true-ditebalkan false-tidak ditebalkan |
| | | | italic | boolean | false | Hanya berkuat kuasa terhadap text, sama ada miring atau tidak, lalai false true-miring false-tidak miring |
| | | | underline | boolean | false | Hanya berkuat kuasa terhadap text, sama ada garis bawah ditambahkan atau tidak, lalai false true-garis bawah ditambahkan false-garis bawah tidak ditambahkan |
| | | | lineThrough | boolean | false | Hanya berkuat kuasa terhadap text, sama ada garis coretan ditambahkan atau tidak, lalai false true-garis coretan ditambahkan false-garis coretan tidak ditambahkan |
| | | | horizontalAlignment | string | false | Hanya berkuat kuasa terhadap text, format tengah mendatar, kiri lalai LEFT-kiri CENTER-Pusat RIGHT-Kanan |
| | | tickBoxField | object | false | Atribut kotak centang |
| | | | tickOptions | array | false | Hanya berkesan untuk tickBox, nilai lalai 1 1-Tanda centang 2-Tanda silang |
| | | posX | float | false | Paksi-X kedudukan kawalan |
| | | posY | float | false | Paksi-Y kedudukan kawalan |
| | | pageNo | string | false | Nombor halaman tempat kawalan berada |
| | signDateConfigs | array | false | Maklumat lokasi tarikh tandatangan |
| | | movable | boolean | false | Benarkan pergerakan semasa penandatangan, nilai lalai false false-Penandatangan tidak dibenarkan menyesuaikan kedudukan kawalan tandatangan sendiri true-Penandatangan dibenarkan menyesuaikan kedudukan kawalan tandatangan 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 "," sebagai pemisah. |
| | | posX | float | false | Anjakan paksi-x, titik asal koordinat ialah di sudut kiri bawah halaman |
| | | posY | float | false | Anjakan paksi-y, titik asal koordinat ialah di sudut kiri bawah halaman |
| | | signDateFormat | string | false | Format tarikh penandatanganan, format lalai ialah yyyy-MM-dd Menyokong format yang ditetapkan: yyyy tahun MM bulan dd hari yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |