Periksa Detail Amplop

GET /esignglobal/v1/envelope/envelopeDetail

Deskripsi Antarmuka

Menanyakan informasi detail tentang amplop, termasuk progres penandatanganan, status amplop, dll.

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Keterangan
envelopeId	string	true	ID Amplop

Contoh Permintaan

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

Parameter Respons

Nama Parameter				Tipe	Keterangan
envelopeId				string	ID Amplop
envelopeStatus				int	Status Amplop 0-Dibuat (Draf) 1-Dalam Penandatanganan 2-Selesai 3-Kedaluwarsa 4-Ditolak 5-Dibatalkan
envelopeEndTime				timestamp	Waktu Berakhir Amplop
envelopeCreateTime				timestamp	Waktu Mulai Amplop
subject				string	Subjek Amplop
remark				string	Catatan Amplop (Panjang 1000)
redirectUrl				string	Alamat Pengalihan Setelah Penandatanganan Selesai (Panjang 500)
CCInfos				array	Kumpulan Informasi Penerima Tembusan
	userEmail			string	Alamat Email Penerima Tembusan
	userName			string	Nama Penerima Tembusan
initiatorInfo				object	Kumpulan Informasi Pengirim
	userName			string	Nama pengirim, defaultnya adalah nama pembuat yang memiliki APPID aplikasi terbuka
signFiles				array	Kumpulan informasi dokumen yang ditandatangani
	fileKey			string	fileKey dokumen yang ditandatangani
attachments				array	Kumpulan lampiran amplop
	fileKey			string	fileKey amplop
signerInfos				array	Informasi penandatangan
	businessId			string	Nomor bisnis khusus pengembang, (panjang 500)
	userName			string	Nama penandatangan
	userEmail			string	Alamat email penandatangan
	phoneNumber			object	Alamat SMS penerima penandatangan
		countryCode		string	Kode internasional negara/wilayah
		number		string	Nomor ponsel penerima pesan penandatangan
	signOrder			int	Urutan penandatanganan penandatangan, minimal 1.
	digitalSignature			boolean	Apakah akan mengaktifkan tanda tangan digital, defaultnya false true-aktif, false-tidak aktif
	authConfig			object	Metode Verifikasi
		accessCode		object	Kata Sandi Akses
			accessCode	string	Kata Sandi Akses
			promptInfo	string	Petunjuk Kata Sandi Akses
		sms		object	Verifikasi OTP SMS
			countryCode	string	Kode internasional negara/wilayah
			number	string	Nomor Ponsel Otentikasi Identitas
		idVerification		object	Verifikasi Identitas
			name	string	Nama lengkap pada dokumen identitas penandatangan
		emailAuth		object	Verifikasi OTP Email
			authEmail	string	Alamat email verifikasi identitas penandatangan
		digitalId		object	Verifikasi Identitas Elektronik
			authApp	string	Aplikasi yang digunakan untuk verifikasi identitas elektronik
			idNumber	string	Nomor dokumen identitas penandatangan yang akan diverifikasi
		whatsappAuth		object	Verifikasi OTP WhatsApp
			countryCode	string	Kode internasional negara/wilayah
			number	string	Nomor ponsel otentikasi identitas
	signerStatus			int	Status penandatangan 0-Menunggu ditandatangani 1-Sedang ditandatangani 2-Sudah ditandatangani
	signDate			timestamp	Waktu penandatanganan
	declinedReason			string	Alasan penolakan, ditampilkan ketika envelopeStatus ditolak
canceledReason				string	Alasan pembatalan, ditampilkan ketika envelopeStatus dibatalkan

Contoh respons

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}