Briefumschlagdetails abfragen

GET /esignglobal/v1/envelope/envelopeDetail

Schnittstellenbeschreibung

Detaillierte Informationen zur Abfrage des Umschlags, einschließlich des Unterzeichnungsfortschritts, des Umschlagsstatus 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 Abschluss der Unterzeichnung (Länge 500)
CCInfos			array	Sammlung von Informationen zu Carbon Copy-Empfängern
	userEmail		string	E-Mail-Adresse des Carbon Copy-Empfängers
	userName		string	Name des CC-Empfängers
initiatorInfo			object	Sammlung von Absenderinformationen
	userName		string	Name des Absenders, standardmäßig der Name des Erstellers der offenen Anwendungs-APPID
signFiles			array	Sammlung von Informationen zu signierten Dateien
	fileKey		string	fileKey der signierten Datei
attachments			array	Sammlung von Umschlaganhängen
	fileKey		string	Umschlag-fileKey
signerInfos			array	Informationen zum Unterzeichner
	businessId		string	Vom Entwickler definierte Geschäftsnummer (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	Mobiltelefonnummer des Unterzeichners für den Empfang von Signiernachrichten
	signOrder		int	Reihenfolge der Unterzeichnung, minimal 1.
	digitalSignature		boolean	Ist die digitale Signatur aktiviert? Standardmäßig false true-Aktiviert, false-Nicht aktiviert
	accessCode		string	Zugangspasswort für die Signaturseite
	signerStatus		int	Status des Unterzeichners 0-Ausstehend 1-In Bearbeitung 2-Signiert
	signDate		timestamp	Signaturzeit
	declinedReason		string	Grund für die Ablehnung, wird angezeigt, wenn envelopeStatus auf Abgelehnt steht
canceledReason			string	Grund für den Widerruf, wird angezeigt, wenn envelopeStatus auf Widerrufen steht

Beispielantwort

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