Visualizza dettagli 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-Annullato
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 file firmati
	fileKey		string	FileKey del file firmato
attachments			array	Raccolta di allegati della busta
	fileKey		string	FileKey della busta
signerInfos			array	Informazioni sul firmatario
	businessId		string	Numero aziendale personalizzato dallo sviluppatore (lunghezza 500)
	userName		string	Nome del firmatario
	userEmail		string	Indirizzo email del firmatario
	phoneNumber		object	Indirizzo SMS di ricezione del firmatario
		countryCode	string	Prefisso internazionale del paese/regione
		number	string	Numero di cellulare del firmatario per ricevere i messaggi di firma
	signOrder		int	Ordine di firma del firmatario, il valore minimo è 1.
	digitalSignature		boolean	Indica se abilitare la firma digitale, predefinito false true-Attiva, false-Disattiva
	accessCode		string	Password di accesso alla pagina di firma
	signerStatus		int	Stato del firmatario 0-In attesa di firma 1-In fase di firma 2-Firmato
	signDate		timestamp	Ora 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,
                "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"
}