Visualizza i dettagli della busta

GET /esignglobal/v1/envelope/envelopeDetail

Descrizione dell'interfaccia

Visualizza le informazioni dettagliate della busta, inclusi l'avanzamento della firma, lo stato della busta, ecc.

Parametri di richiesta

Nome parametro	Tipo	Obbligatorio	Descrizione
envelopeId	string	true	ID busta

Esempio di richiesta

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

Parametri di risposta

Nome parametro				Tipo	Descrizione
envelopeId				string	ID busta
envelopeStatus				int	Stato della busta 0-Creato (Bozza) 1-In fase di firma 2-Completato 3-Scaduto 4-Rifiutato 5-Revocato
envelopeEndTime				timestamp	Ora di fine della busta
envelopeCreateTime				timestamp	Ora di inizio della busta
subject				string	Oggetto della busta
remark				string	Note sulla busta (lunghezza 1000)
redirectUrl				string	Indirizzo di reindirizzamento al completamento della firma (lunghezza 500)
CCInfos				array	Raccolta di informazioni sui destinatari in copia conoscenza
	userEmail			string	Indirizzo email del destinatario in copia conoscenza
	userName			string	Nome del destinatario in copia conoscenza
initiatorInfo				object	Raccolta di informazioni sul mittente
	userName			string	Nome del mittente, per impostazione predefinita il nome del creatore a cui appartiene l'APPID dell'applicazione aperta
signFiles				array	Raccolta di informazioni sui documenti da firmare
	fileKey			string	fileKey del documento da firmare
attachments				array	Raccolta di allegati della busta
	fileKey			string	fileKey della busta
signerInfos				array	Informazioni sul firmatario
	businessId			string	Numero di business personalizzato dallo sviluppatore (lunghezza 500)
	userName			string	Nome del firmatario
	userEmail			string	Indirizzo email del firmatario
	phoneNumber			object	Indirizzo SMS per la ricezione del firmatario
		countryCode		string	Prefisso internazionale del paese/regione
		number		string	Numero di cellulare del firmatario per ricevere messaggi di firma
	signOrder			int	Ordine di firma del firmatario, il valore minimo è 1.
	digitalSignature			boolean	Se abilitare la firma digitale, predefinito false true-abilita, false-non abilita
	authConfig			object	Metodo di verifica
		accessCode		object	Password di accesso
			accessCode	string	Password di accesso
			promptInfo	string	Suggerimento password di accesso
		sms		object	Verifica OTP via SMS
			countryCode	string	Prefisso internazionale del paese/regione
			number	string	Numero di cellulare per l'autenticazione dell'identità
		idVerification		object	Verifica dell'identità
			name	string	Nome completo sul documento d'identità del firmatario
		emailAuth		object	Verifica OTP via email
			authEmail	string	Indirizzo email per la verifica dell'identità del firmatario
		digitalId		object	Verifica dell'identità elettronica
			authApp	string	APP utilizzata per la verifica dell'identità elettronica
			idNumber	string	Numero del documento d'identità del firmatario da verificare
		whatsappAuth		object	Verifica OTP via WhatsApp
			countryCode	string	Codice internazionale del paese/regione
			number	string	Numero di cellulare per l'autenticazione dell'identità
	signerStatus			int	Stato del firmatario 0 - In attesa di firma 1 - In fase di firma 2 - Firmato
	signDate			timestamp	Data della firma
	declinedReason			string	Motivo del rifiuto, visualizzato quando envelopeStatus è Rifiutato
canceledReason				string	Motivo dell'annullamento, visualizzato quando envelopeStatus è Annullato

Esempio di risposta

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