Consultar detalles del sobre

GET /esignglobal/v1/envelope/envelopeDetail

Descripción de la interfaz

Consulta la información detallada del sobre, incluyendo el progreso de la firma, el estado del sobre, etc.

Parámetros de solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
envelopeId	string	true	ID del sobre

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro			Tipo	Descripción
envelopeId			string	ID del sobre
envelopeStatus			int	Estado del sobre 0-Creado (Borrador) 1-En proceso de firma 2-Completado 3-Vencido 4-Rechazado 5-Anulado
envelopeEndTime			timestamp	Hora de finalización del sobre
envelopeCreateTime			timestamp	Hora de inicio del sobre
subject			string	Asunto del sobre
remark			string	Notas del sobre (longitud 1000)
redirectUrl			string	Dirección de redireccionamiento al completar la firma (longitud 500)
CCInfos			array	Colección de información de destinatarios de copia
	userEmail		string	Dirección de correo electrónico del destinatario de copia
	userName		string	Nombre del destinatario en copia
initiatorInfo			object	Conjunto de información del remitente
	userName		string	Nombre del remitente, por defecto el nombre del creador al que pertenece el APPID de la aplicación abierta
signFiles			array	Conjunto de información del archivo a firmar
	fileKey		string	fileKey del archivo a firmar
attachments			array	Conjunto de archivos adjuntos del sobre
	fileKey		string	fileKey del sobre
signerInfos			array	Información del firmante
	businessId		string	Número de negocio personalizado por el desarrollador (longitud 500)
	userName		string	Nombre del firmante
	userEmail		string	Dirección de correo electrónico del firmante
	phoneNumber		object	Dirección SMS del destinatario del firmante
		countryCode	string	Código internacional del país/región
		number	string	Número de teléfono móvil del firmante para recibir mensajes de firma
	signOrder		int	Orden de firma del firmante, el mínimo es 1.
	digitalSignature		boolean	Si se habilita la firma digital, el valor predeterminado es falso true-Activado, false-Desactivado
	accessCode		string	Contraseña de acceso a la página de firma
	signerStatus		int	Estado del firmante 0-Pendiente de firma 1-En firma 2-Firmado
	signDate		timestamp	Fecha de firma
	declinedReason		string	Motivo del rechazo, se muestra cuando envelopeStatus es Rechazado
canceledReason			string	Motivo de la revocación, se muestra cuando envelopeStatus es Revocado

Ejemplo de respuesta

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