Consultar Detalhes do Envelope

GET /esignglobal/v1/envelope/envelopeDetail

Descrição da Interface

Consulta informações detalhadas do envelope, incluindo o progresso da assinatura, o estado do envelope, etc.

Parâmetros de Requisição

Nome do Parâmetro	Tipo	Obrigatório	Descrição
envelopeId	string	true	ID do Envelope

Exemplo de Requisição

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

Parâmetros de Resposta

Nome do Parâmetro				Tipo	Descrição
envelopeId				string	ID do Envelope
envelopeStatus				int	Estado do Envelope 0 - Criado (Rascunho) 1 - A Assinar 2 - Concluído 3 - Expirado 4 - Rejeitado 5 - Revogado
envelopeEndTime				timestamp	Hora de Fim do Envelope
envelopeCreateTime				timestamp	Hora de Início do Envelope
subject				string	Assunto do Envelope
remark				string	Observações do Envelope (comprimento 1000)
redirectUrl				string	Endereço de Redirecionamento Após Conclusão da Assinatura (comprimento 500)
CCInfos				array	Conjunto de Informações do Cópia
	userEmail			string	Endereço de Email do Cópia
	userName			string	Nome do Cópia
initiatorInfo				object	Conjunto de Informações do Remetente
	userName			string	Nome do remetente, por defeito o nome do criador pertencente ao APPID da aplicação aberta
signFiles				array	Conjunto de informações do documento de assinatura
	fileKey			string	fileKey do documento de assinatura
attachments				array	Conjunto de anexos do envelope
	fileKey			string	fileKey do envelope
signerInfos				array	Informação do signatário
	businessId			string	Número de negócio personalizado pelo desenvolvedor (comprimento 500)
	userName			string	Nome do signatário
	userEmail			string	Endereço de e-mail do signatário
	phoneNumber			object	Endereço SMS do signatário para receber
		countryCode		string	Código internacional do país/região
		number		string	Número de telemóvel do signatário para receber mensagens de assinatura
	signOrder			int	Ordem de assinatura do signatário, o mínimo é 1.
	digitalSignature			boolean	Se a assinatura digital está ativada, por defeito é false true - Ativado, false - Desativado
	authConfig			object	Método de verificação
		accessCode		object	Palavra-passe de acesso
			accessCode	string	Palavra-passe de acesso
			promptInfo	string	Informação de sugestão da palavra-passe de acesso
		sms		object	Verificação OTP por SMS
			countryCode	string	Código internacional do país/região
			number	string	Número de telemóvel para autenticação de identidade
		idVerification		object	Verificação de identidade
			name	string	Nome completo no documento de identificação do signatário
		emailAuth		object	Verificação OTP por e-mail
			authEmail	string	Endereço de e-mail para verificação de identidade do signatário
		digitalId		object	Autenticação de identidade eletrónica
			authApp	string	APP utilizada para autenticação de identidade eletrónica
			idNumber	string	Número do documento de identificação do signatário a ser verificado
		whatsappAuth		object	Verificação OTP por WhatsApp
			countryCode	string	Código internacional do país/região
			number	string	Número de telemóvel para autenticação de identidade
	signerStatus			int	Estado do signatário 0 - Pendente de assinatura 1 - A assinar 2 - Assinado
	signDate			timestamp	Data da assinatura
	declinedReason			string	Motivo da recusa, exibido quando o envelopeStatus é Recusado
canceledReason				string	Motivo da revogação, exibido quando o envelopeStatus é Revogado

Exemplo de resposta

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