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
envelopeCreateTime			timestamp	Masa Mula Sampul
subject			string	Subjek Sampul
remark			string	Nota Sampul (Panjang 1000)
redirectUrl			string	Alamat Pengalihan Selepas Menandatangani Selesai (Panjang 500)
CCInfos			array	Koleksi Maklumat Penerima Salinan
	userEmail		string	Alamat E-mel Penerima Salinan
	userName		string	Nama Penerima Salinan
initiatorInfo			object	Kumpulan Maklumat Penghantar
	userName		string	Nama penghantar, lalai kepada nama pencipta yang dimiliki oleh APPID aplikasi terbuka
signFiles			array	Kumpulan Maklumat Fail Tandatangan
	fileKey		string	fileKey fail tandatangan
attachments			array	Kumpulan 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/Wilayah
		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 ialah false true-Aktif, false-Tidak Aktif
	accessCode		string	Kata Laluan Akses Halaman Tandatangan
	signerStatus		int	Status Penandatangan 0-Menunggu Tandatangan 1-Sedang Ditandatangani 2-Sudah Ditandatangani
	signDate		timestamp	Masa Tandatangan
	declinedReason		string	Sebab Penolakan, dipaparkan apabila envelopeStatus adalah Ditolak
canceledReason			string	Sebab Pembatalan, dipaparkan apabila envelopeStatus adalah Dibatalkan

Contoh Respons

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "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"
}