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	Jenis	Wajib	Keterangan
envelopeId	string	true	ID Amplop

Contoh Permintaan

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

Parameter Respons

Nama Parameter			Jenis	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 milik APPID aplikasi terbuka
signFiles			array	Kumpulan Informasi File yang Ditandatangani
	fileKey		string	fileKey file 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
	accessCode		string	Kata Sandi Akses Halaman Penandatanganan
	signerStatus		int	Status Penandatangan 0-Menunggu Ditandatangani 1-Sedang Ditandatangani 2-Sudah Ditandatangani
	signDate		timestamp	Waktu Penandatanganan
	declinedReason		string	Alasan Penolakan, ditampilkan ketika envelopeStatus adalah Ditolak
canceledReason			string	Alasan Pembatalan, ditampilkan ketika 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"
}