Details zur Abfrage von Umschlägen

GET /esignglobal/v1/envelope/envelopeDetail

Schnittstellenbeschreibung

Abfrage der Detailinformationen zum Umschlag, einschließlich Unterzeichnungsfortschritt, Umschlagstatus usw.

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
envelopeId	string	true	Umschlag-ID

Beispielanfrage

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

Antwortparameter

Parametername				Typ	Beschreibung
envelopeId				string	Umschlag-ID
envelopeStatus				int	Umschlagstatus 0-Erstellt (Entwurf) 1-In Bearbeitung 2-Abgeschlossen 3-Abgelaufen 4-Abgelehnt 5-Widerrufen
envelopeEndTime				timestamp	Endzeit des Umschlags
envelopeCreateTime				timestamp	Startzeit des Umschlags
subject				string	Betreff des Umschlags
remark				string	Umschlag-Notizen (Länge 1000)
redirectUrl				string	Weiterleitungsadresse nach Unterzeichnung (Länge 500)
CCInfos				array	Sammlung von Informationen zu CC-Empfängern
	userEmail			string	E-Mail-Adresse des CC-Empfängers
	userName			string	Name des CC-Empfängers
initiatorInfo				object	Sammlung von Informationen zum Absender
	userName			string	Name des Absenders, standardmäßig der Name des Erstellers der offenen Anwendungs-APPID
signFiles				array	Sammlung von Informationen zu signierten Dokumenten
	fileKey			string	fileKey der signierten Datei
attachments				array	Sammlung von Briefumschlaganhängen
	fileKey			string	fileKey des Briefumschlags
signerInfos				array	Informationen zum Unterzeichner
	businessId			string	Benutzerdefinierte Geschäftsnummer des Entwicklers (Länge 500)
	userName			string	Name des Unterzeichners
	userEmail			string	E-Mail-Adresse des Unterzeichners
	phoneNumber			object	SMS-Adresse des Unterzeichners
		countryCode		string	Internationale Vorwahl des Landes/der Region
		number		string	Handynummer des Unterzeichners zum Empfangen von Signaturnachrichten
	signOrder			int	Reihenfolge der Unterzeichner, minimal 1.
	digitalSignature			boolean	Ob die digitale Signatur aktiviert werden soll, standardmäßig false true - aktivieren, false - nicht aktivieren
	authConfig			object	Verifizierungsmethode
		accessCode		object	Zugangspasswort
			accessCode	string	Zugangspasswort
			promptInfo	string	Hinweis zum Zugangspasswort
		sms		object	SMS-OTP-Verifizierung
			countryCode	string	Internationale Vorwahl für Land/Region
			number	string	Mobiltelefonnummer für die Identitätsprüfung
		idVerification		object	Identitätsprüfung
			name	string	Vollständiger Name auf dem Ausweisdokument des Unterzeichners
		emailAuth		object	E-Mail-OTP-Verifizierung
			authEmail	string	E-Mail-Adresse des Unterzeichners zur Identitätsprüfung
		digitalId		object	Elektronische Identitätsprüfung
			authApp	string	Für die elektronische Identitätsprüfung verwendete APP
			idNumber	string	Zu verifizierende Ausweisnummer des Unterzeichners
		whatsappAuth		object	WhatsApp-OTP-Verifizierung
			countryCode	string	Internationale Vorwahl für Länder und Regionen
			number	string	Mobiltelefonnummer zur Identifizierung
	signerStatus			int	Status des Unterzeichners 0 - Ausstehende Unterschrift 1 - In Bearbeitung der Unterschrift 2 - Unterschrieben
	signDate			timestamp	Unterschriftszeitpunkt
	declinedReason			string	Grund für die Ablehnung, wird angezeigt, wenn envelopeStatus auf abgelehnt gesetzt ist
canceledReason				string	Grund für den Widerruf, wird angezeigt, wenn envelopeStatus auf widerrufen gesetzt ist

Beispielantwort

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