Mulai Amplop dengan Cepat

POST /esignglobal/v1/envelope/createAndStart

Deskripsi Antarmuka

Dengan cepat memulai amplop, termasuk membuat amplop, menambahkan dokumen yang akan ditandatangani, menambahkan penandatangan, dan fungsi lainnya.

Mendukung pembukaan otomatis：Setelah panggilan antarmuka berhasil, amplop berhasil dibuat dan dibuka, dan amplop secara otomatis mulai beredar.
Mendukung pengakhiran otomatis：Setelah semua pihak penandatangan menyelesaikan penandatanganan, amplop secara otomatis diakhiri.

Parameter Permintaan

Nama Parameter					Jenis	Wajib Diisi	Keterangan
subject					string	true	Subjek Amplop Contoh: “Offer Letter”
remark					string	false	Catatan Amplop，Batas panjang 1000 karakter
signerSettings					object	false	Operasi yang diizinkan untuk penandatangan
	allowTransfer				boolean	false	Apakah penandatangan diizinkan untuk meneruskan amplop ini ke orang lain untuk ditandatangani, defaultnya adalah false true-Mengizinkan penandatangan dalam amplop untuk memiliki hak untuk meneruskan amplop ke orang lain; false-Tidak mengizinkan penandatangan dalam amplop untuk memiliki hak untuk meneruskan amplop ke orang lain;
	allowModifyName				boolean	false	Apakah pihak penandatangan diizinkan untuk mengubah nama, hanya berlaku untuk tanda tangan templat, defaultnya adalah false true-Mengizinkan penandatangan untuk mengubah nama false-Tidak mengizinkan penandatangan untuk mengubah nama
expireAfterSeconds					long	false	Waktu kedaluwarsa amplop, setelah berapa detik amplop akan kedaluwarsa Rentang kedaluwarsa: 86.400 detik (1 hari) ~ 7.776.000 detik (90 hari)
redirectUrl					string	false	Harus berupa alamat https yang valid
callBackUrl					string	false	Alamat panggilan balik (panjang 500), harus sesuai dengan alamat protokol https.
sendLaterAfterSeconds					long	false	Mendukung pengguna untuk menunda pengiriman, dalam satuan detik Rentang waktu yang didukung: 3600 detik (1 jam) ~ 259200 detik (30 hari)
CCInfos					array	false	Kumpulan informasi penerima tembusan
	userEmail				string	false	Alamat email penerima tembusan
	userName				string	false	Nama CC, digunakan untuk menampilkan nama CC di halaman penandatanganan dan amplop. 【Perhatian】: Tidak boleh mengandung 9 karakter khusus berikut: / \ : * " < > \| ？dan semua emoji
	customizeSettings				object	false	Konfigurasi Kustom
		notificationSettings			object	false	Konfigurasi Kustom Tipe Notifikasi
			notificationLanguage		string	false	Bahasa Notifikasi, default mengambil konfigurasi “Bahasa Notifikasi Default” en-US Bahasa Inggris zh-CN Bahasa Mandarin Sederhana zh-Hant Bahasa Mandarin Tradisional ja-JP Bahasa Jepang es-MX Bahasa Spanyol pt-PT Bahasa Portugis th-TH Bahasa Thailand id-ID Bahasa Indonesia vi-VN Bahasa Vietnam ms-MY Bahasa Melayu fil-PH Bahasa Filipina de-DE Bahasa Jerman fr-FR Bahasa Prancis ru-RU Bahasa Rusia it-IT Bahasa Italia ko-KR Bahasa Korea
signFiles					array	true	Kumpulan informasi dokumen yang ditandatangani, urutan tampilan adalah urutan penambahan dokumen.
	fileKey				string	true	fileKey dokumen yang ditandatangani, hanya mendukung format PDF
attachments					array	false	Kumpulan lampiran amplop, urutan tampilan adalah urutan penambahan dokumen.
	fileKey				string	false	fileKey dokumen
signerInfos					array	true	Kumpulan informasi penandatangan
	businessId				string	false	Nomor bisnis khusus pengembang, batasan panjang 500
	deliveryMethods				string	false	Metode notifikasi, defaultnya adalah auto auto-Kirim notifikasi email saat userEmail diteruskan, kirim notifikasi SMS saat phoneNumber diteruskan none-Jangan kirim notifikasi pesan email- Kirim pemberitahuan email sms- Kirim pemberitahuan SMS WhatsApp- Kirim pemberitahuan WhatsApp
	userEmail				string	false	Alamat email penandatangan
	userName				string	true	Nama penandatangan, digunakan untuk menampilkan nama penandatangan di halaman penandatanganan dan amplop. 【Catatan】Tidak boleh mengandung 9 karakter khusus berikut: / \ : * " < > \| ？dan semua emoji
	phoneNumber				object	false	Nomor telepon, defaultnya kosong Parameter ini wajib diisi saat pemberitahuan SMS diperlukan, countryCode dan number harus diteruskan
		countryCode			string	false	Kode internasional negara/wilayah, tidak perlu memasukkan “+”
		number			string	false	Tidak ada validasi format, hanya membatasi panjang maksimum 13 digit
	customizeSettings				object	false	Konfigurasi khusus
		notificationSettings			object	false	Konfigurasi khusus untuk pemberitahuan
			customizeMessage		string	false	Pemberitahuan pesan eksklusif, batas karakter 200
			notificationLanguage		string	false	Bahasa pemberitahuan, defaultnya mengambil konfigurasi “Bahasa pemberitahuan default” en-US Bahasa Inggris zh-CN Cina Sederhana zh-Hant Cina Tradisional ja-JP Jepang es-MX Spanyol pt-PT Portugis th-TH Thailand id-ID Bahasa Indonesia vi-VN Vietnam ms-MY Melayu fil-PH Filipina de-DE Jerman fr-FR Prancis ru-RU Rusia it-IT Italia ko-KR Korea
	signOrder				int	true	Urutan penandatanganan oleh penanda tangan, minimal 1. Tanda tangan tidak berurutan dapat menentukan nilai urutan yang sama.
	anySigner				boolean	false	Apakah mendukung penandatanganan oleh salah satu orang, defaultnya false true-Hanya satu orang yang perlu menandatangani dengan signOrder yang sama false-Semua orang dengan signOrder yang sama harus menandatangani
	authModes				string	false	Metode verifikasi, defaultnya adalah noAuth noAuth-Tidak ada verifikasi accessCode-Verifikasi menggunakan kata sandi penandatanganan sms-Verifikasi OTP SMS idVerification-Verifikasi identitas dengan kartu identitas emailAuth-Verifikasi OTP Email digitalId-Verifikasi identitas elektronik whatsappAuth-Verifikasi OTP WhatsApp
	authConfig				object	false	Pengaturan metode verifikasi
		accessCode			object	false	Pengaturan kata sandi penandatanganan, ketika authModes=accessCodewajib diisi
			accessCode		string	false	Isi kata sandi, tidak peka huruf besar/kecil, dapat berisi huruf dan angka, batasan panjang 45
			promptInfo		string	false	Informasi petunjuk kata sandi akses, tidak boleh berisi kata sandi akses, batasan panjang 30, wajib diisi ketika authModes=accessCode .
		sms			object	false	Verifikasi SMS OTP, wajib diisi ketika authModes=sms wajib diisi
			countryCode		string	false	Kode internasional negara/wilayah, tidak perlu memasukkan tanda “+”
			number		string	false	Tidak ada validasi format, hanya batasan panjang maksimum 13 digit
		idVerification			object	false	Pengaturan verifikasi identitas, wajib diisi ketika authModes=idVerification wajib diisi
			name		string	false	Nama lengkap pada kartu identitas penandatangan, panjang maksimum 100 karakter
		emailAuth			object	false	Verifikasi Email OTP, wajib diisi ketika authModes=emailAuth wajib diisi
			authEmail		string	false	Alamat email verifikasi identitas penandatangan
		digitalId			array	false	Verifikasi identitas elektronik, wajib diisi ketika authModes=digitalId
			authApp		string	false	Aplikasi yang digunakan untuk verifikasi identitas elektronik singpass- Gunakan Singpass untuk otentikasi iamsmart- Gunakan i AM Smart untuk otentikasi
			idNumber		string	false	Nomor identitas penandatangan yang menunggu verifikasi Ketika authApp=singpassaturan yang diteruskan adalah: huruf kapital + 7 atau 8 digit angka + huruf kapital Ketika authApp=iamsmartaturan yang diteruskan adalah: 1. Satu huruf kapital (A-Z), atau dua huruf kapital (AA-ZZ), sebagai awal dari urutan; 2. Diikuti oleh 6 digit angka; 3. Terakhir adalah kode pemeriksaan, yang bisa berupa angka (0-9) atau huruf (A-Z). Contoh: A888888(A)
		whatsappAuth			object	false	Verifikasi OTP WhatsApp, wajib diisi ketika authModes=whatsappAuth
			countryCode		string	false	Kode internasional negara/wilayah, tidak perlu menyertakan tanda “+”
			number		string	false	Tidak ada validasi format, hanya batasan panjang maksimum 13 digit
	digitalSignature				boolean	false	Apakah akan mengaktifkan tanda tangan digital, defaultnya false true-aktif, false-tidak aktif
	freeFormSign				boolean	false	Apakah penandatangan menandatangani dengan bebas, nilai defaultnya adalah false Catatan tambahan: Ketika freeFormSign dipilih sebagai true, parameter lain di bawah sealInfos tidak perlu diteruskan. Jika diteruskan secara bersamaan, prioritas freeFormSign lebih tinggi daripada sealInfos, dan parameter di bawah sealInfos tidak akan berlaku [Perhatian]Tanda tangan bebas berarti tidak ada batasan jumlah dan posisi stempel/tanda tangan yang dapat diseret oleh penandatangan
	sealInfos				array	false	Informasi tugas penandatanganan
		fileKey			string	true	fileKey file penandatanganan
		signConfigs			array	false	Informasi posisi kontrol, informasi posisi kontrol harus ditentukan agar tanda tangan elektronik dapat dilakukan.
			fieldType		string	false	Jenis kontrol, defaultnya adalah signature signature- Kontrol tanda tangan stamp- Kontrol stempel approval- Kontrol persetujuan
			sizeRule		string	false	Cara menampilkan ukuran area penandatanganan originalSize- Jatuhkan stempel sesuai dengan ukuran sebenarnya dari tanda tangan/stempel targetSize- Sesuaikan lebar dan tinggi area tanda tangan/stempel Ketika sizeRule, height, width semuanya kosong, stempel akan ditempatkan sesuai dengan ukuran sebenarnya dari tanda tangan/stempel; Ketika sizeRule kosong, height, width tidak kosong, stempel akan ditempatkan sesuai dengan ukuran yang ditentukan; Ketika sizeRule tidak kosong, stempel akan ditempatkan sesuai dengan metode tampilan yang ditentukan.
			height		int	false	Tinggi kontrol penandatanganan, berlaku untuk fieldType signature/stamp, satuan dalam px, hanya mendukung input bilangan bulat positif, default adalah auto (yaitu ukuran otomatis sistem); Ketika fieldType=signature, rentang yang dapat diatur adalah 20-250px; Ketika fieldType=stamp, rentang yang dapat diatur adalah 30-280px;
			width		int	false	Lebar kontrol penandatanganan, berlaku untuk fieldType signature/stamp, satuan dalam px, hanya mendukung input bilangan bulat positif, default adalah auto (yaitu ukuran otomatis sistem); Ketika fieldType=signature, rentang yang dapat diatur adalah 20-250px; Ketika fieldType=stamp, rentang yang dapat diatur adalah 30-280px;
			signatureOptions		string	false	Opsi kontrol tanda tangan. Hanya berlaku untuk fieldType signature Parameter yang dapat dimasukkan: template: Tanda tangan template handDrawn: Tanda tangan yang digambar tangan upload: Unggah gambar tanda tangan lokal Dapat memilih beberapa, dipisahkan dengan ",", default adalah pilih semua
			movable		boolean	false	Izinkan memindahkan lokasi saat menandatangani, defaultnya false false-Tidak mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri true-Mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri
			allowedOptions		array	false	Opsi yang diizinkan untuk disetujui oleh penandatangan, berlaku untuk fieldType approval. Defaultnya adalah ["approve", "decline"] approve-Setuju decline-Tolak
			pageNo		string	false	Halaman penandatanganan; halaman berurutan dihubungkan dengan "-", halaman terpisah dihubungkan dengan "," Contoh: 1-3,6-10
			posX		float	false	Koordinat sumbu x 【Perhatian】Jika fieldType adalah signature, maka posisi koordinat mengacu pada area tanda tanganSudut kiri bawah； Jika fieldType adalah stamp, maka posisi koordinat mengacu pada area stempelTitik tengahPosisi Mulai 3 Februari 2026, fieldType adalah signature atau stamp, posisi koordinatnya mengacu pada posisi titik tengah area stempel.
			posY		float	false	Koordinat sumbu y 【Perhatian】Jika fieldType adalah signature, maka posisi koordinat mengacu pada area tanda tanganSudut kiri bawah； Jika fieldType adalah stamp, maka posisi koordinat mengacu pada area stempelTitik tengahPosisi Mulai 3 Februari 2026, fieldType untuk signature atau stamp, posisi koordinat mengacu pada posisi titik tengah area stempel.
		fillConfigs			array	false	Isi informasi kontrol
			fieldName		string	false	Nama kontrol, batasan jumlah karakter 128
			required		boolean	false	Apakah wajib diisi, default wajib diisi true-Wajib diisi false-Tidak wajib diisi
			fieldType		string	false	Tipe kontrol: 1-Teks satu baris 15-Kotak centang
			textField		object	false	Properti Kontrol Teks
				overflowType	int	false	Hanya berlaku untuk teks, default 1 1-Otomatis memperkecil ukuran font 2-Batasi input
				minFontSize	float	false	Hanya berlaku untuk teks, hanya berlaku untuk overflowType=1, default 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 kontrol, default 160px
				font	int	false	Hanya berlaku untuk teks, font, default SimSun 1-SimSun 2-NSimSun 4-Heiti 5-Kaiti 6-Arial 7-Helvetica 9-Times New Roman 10-Fangsong 11-Georgia 12-Monospace
				fontSize	float	false	Hanya berlaku untuk teks, ukuran font, default 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 berlaku untuk teks, warna heksadesimal, default hitam #000
				bold	boolean	false	Hanya berlaku untuk teks, apakah font tebal, default false true-Tebal false-Tidak Tebal
				italic	boolean	false	Hanya berlaku untuk teks, apakah miring, default false true-Miring false-Tidak Miring
				underline	boolean	false	Hanya berlaku untuk teks, apakah font ditambahkan garis bawah, default false true-Tambahkan garis bawah false-Jangan tambahkan garis bawah
				lineThrough	boolean	false	Hanya berlaku untuk teks, apakah menambahkan coretan, default false true-Tambahkan coretan false-Jangan tambahkan coretan
				horizontalAlignment	string	false	Hanya berlaku untuk teks, format rata tengah horizontal, default left LEFT-Rata kiri CENTER-Rata tengah RIGHT-Rata kanan
			tickBoxField		object	false	Atribut Kotak Centang
				tickOptions	array	false	Hanya berlaku untuk tickBox, default 1 1-Centang 2-Silang
			posX		float	false	Koordinat X horizontal posisi kontrol
			posY		float	false	Koordinat Y vertikal posisi kontrol
			pageNo		string	false	Nomor halaman tempat kontrol berada
		signDateConfigs			array	false	Informasi posisi tanggal penandatanganan
			movable		boolean	false	Izinkan memindahkan posisi saat menandatangani, default false false-Tidak mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri true-Mengizinkan penandatangan untuk menyesuaikan posisi kontrol penandatanganan mereka sendiri
			pageNo		string	false	Nomor halaman penandatanganan; nomor halaman berurutan dihubungkan dengan "-", nomor halaman tunggal dihubungkan dengan ","，Contoh: 1-3, 6-10; Jika tidak berurutan, masukkan "," untuk memisahkan.
			posX		float	false	Offset sumbu x, sudut kiri bawah halaman adalah titik asal koordinat
			posY		float	false	Offset sumbu y, sudut kiri bawah halaman sebagai titik asal koordinat
			signDateFormat		string	false	Format tanggal penandatanganan, format default adalah yyyy-MM-dd Mendukung format yang ditentukan: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

Contoh Permintaan

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

Parameter Respons

Nama Parameter		Tipe	Deskripsi
envelopeId		string	ID Amplop
CCInfos		array	Kumpulan informasi tembusan
	userEmail	string	Alamat email tembusan
	userName	string	Nama tembusan
signFiles		array	Kumpulan informasi file penandatanganan
	fileKey	string	FileKey file penandatanganan
attachments		array	Kumpulan Lampiran Amplop
	fileKey	string	File fileKey
signerInfos		array	Informasi Tanda Tangan
	businessId	string	Nomor bisnis kustom pengembang, batasan panjang 500
	userEmail	string	Alamat email penanda tangan
	userName	string	Nama penanda tangan
	signUrl	string	Alamat tautan tanda tangan
	signOrder	int	Urutan tanda tangan penanda tangan, minimal 1
	accessCode	string	Kata sandi akses halaman tanda tangan

Contoh respons

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