Semak Butiran Sampul Surat

GET /esignglobal/v1/envelope/envelopeDetail

Deskripsi Antara Muka

Menyemak maklumat terperinci sampul surat, termasuk kemajuan tandatangan, status sampul surat, dsb.

Parameter Permintaan

Nama Parameter	Jenis	Diperlukan	Keterangan
envelopeId	string	true	ID Sampul Surat

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Jenis	Keterangan
envelopeId				string	ID Sampul Surat
envelopeStatus				int	Status Sampul Surat 0-Dicipta (Draf) 1-Dalam Proses Menandatangani 2-Selesai 3-Telah Tamat Tempoh 4-Ditolak 5-Dibatalkan
envelopeEndTime				timestamp	Masa Tamat Sampul Surat
envelopeCreateTime				timestamp	Masa Mula Sampul Surat
subject				string	Tajuk Sampul Surat
remark				string	Catatan Sampul Surat (Panjang 1000)
redirectUrl				string	Alamat Ubah Hala Selepas Selesai Menandatangani (Panjang 500)
CCInfos				array	Koleksi Maklumat Penerima Salinan
	userEmail			string	Alamat E-mel Penerima Salinan
	userName			string	Nama Penerima Salinan
initiatorInfo				object	Koleksi Maklumat Penghantar
	userName			string	Nama pengirim, lalai kepada nama pencipta yang dimiliki oleh APPID aplikasi terbuka
signFiles				array	Koleksi maklumat fail yang ditandatangani
	fileKey			string	fileKey fail yang ditandatangani
attachments				array	Koleksi lampiran sampul surat
	fileKey			string	fileKey sampul surat
signerInfos				array	Maklumat penandatangan
	businessId			string	Nombor perniagaan tersuai pembangun, (panjang 500)
	userName			string	Nama penandatangan
	userEmail			string	Alamat e-mel penandatangan
	phoneNumber			object	Alamat SMS penerima penandatangan
		countryCode		string	Kod antarabangsa negara/rantau
		number		string	Nombor telefon bimbit penerima mesej tandatangan penandatangan
	signOrder			int	Urutan tandatangan penandatangan, minimum ialah 1.
	digitalSignature			boolean	Sama ada untuk menghidupkan tandatangan digital, lalai adalah false true-hidupkan, false-jangan hidupkan
	authConfig			object	Kaedah Pengesahan
		accessCode		object	Kata Laluan Akses
			accessCode	string	Kata Laluan Akses
			promptInfo	string	Petunjuk Kata Laluan Akses
		sms		object	Pengesahan OTP SMS
			countryCode	string	Kod Antarabangsa Negara/Wilayah
			number	string	Nombor Telefon Pengesahan Identiti
		idVerification		object	Pengesahan Identiti
			name	string	Nama Penuh pada Dokumen Pengenalan Penandatangan
		emailAuth		object	Pengesahan OTP E-mel
			authEmail	string	Alamat E-mel Pengesahan Identiti Penandatangan
		digitalId		object	Pengesahan Identiti Elektronik
			authApp	string	APP yang digunakan untuk Pengesahan Identiti Elektronik
			idNumber	string	Nombor Dokumen Pengenalan Penandatangan yang Belum Disahkan
		whatsappAuth		object	Pengesahan OTP WhatsApp
			countryCode	string	Kod antarabangsa negara/rantau
			number	string	Nombor telefon bimbit pengesahan identiti
	signerStatus			int	Status penandatangan 0-Menunggu untuk ditandatangani 1-Sedang ditandatangani 2-Telah ditandatangani
	signDate			timestamp	Masa menandatangani
canceledReason				string	Sebab pembatalan, dipaparkan apabila 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"
}