Consulter les détails de l'enveloppe

GET /esignglobal/v1/envelope/envelopeDetail

Description de l'interface

Récupérer les informations détaillées de l'enveloppe, y compris la progression de la signature, l'état de l'enveloppe, etc.

Paramètres de requête

Nom du paramètre	Type	Obligatoire	Description
envelopeId	string	true	ID de l'enveloppe

Exemple de requête

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

Paramètres de réponse

Nom du paramètre			Type	Description
envelopeId			string	ID de l'enveloppe
envelopeStatus			int	État de l'enveloppe 0-Créé (brouillon) 1-En cours de signature 2-Terminé 3-Expiré 4-Refusé 5-Annulé
envelopeEndTime			timestamp	Heure de fin de l'enveloppe
envelopeCreateTime			timestamp	Heure de début de l'enveloppe
subject			string	Sujet de l'enveloppe
remark			string	Remarques sur l'enveloppe (longueur 1000)
redirectUrl			string	Adresse de redirection après signature (longueur 500)
CCInfos			array	Ensemble d'informations sur les personnes en copie
	userEmail		string	Adresse e-mail de la personne en copie
	userName		string	Nom du destinataire en copie
initiatorInfo			object	Ensemble d'informations sur l'expéditeur
	userName		string	Nom de l'expéditeur, par défaut le nom du créateur auquel appartient l'APPID de l'application ouverte
signFiles			array	Ensemble d'informations sur les fichiers à signer
	fileKey		string	fileKey du fichier à signer
attachments			array	Ensemble de pièces jointes à l'enveloppe
	fileKey		string	fileKey de l'enveloppe
signerInfos			array	Informations sur le signataire
	businessId		string	Numéro d'entreprise personnalisé par le développeur (longueur 500)
	userName		string	Nom du signataire
	userEmail		string	Adresse e-mail du signataire
	phoneNumber		object	Adresse SMS de réception du signataire
		countryCode	string	Indicatif international du pays/de la région
		number	string	Numéro de téléphone portable du signataire pour recevoir les messages de signature
	signOrder		int	Ordre de signature du signataire, le minimum est 1.
	digitalSignature		boolean	Indique si la signature numérique est activée, false par défaut true - activé, false - désactivé
	accessCode		string	Mot de passe d'accès à la page de signature
	signerStatus		int	Statut du signataire 0 - En attente de signature 1 - En cours de signature 2 - Signé
	signDate		timestamp	Heure de signature
	declinedReason		string	Motif du refus, affiché lorsque envelopeStatus est Refusé
canceledReason			string	Motif de l'annulation, affiché lorsque envelopeStatus est Annulé

Exemple de réponse

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