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-Revocado
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 Redirección al Completar la Firma (Longitud 500)
CCInfos				array	Colección de Información de Copias al Carbón
	userEmail			string	Dirección de Correo Electrónico de la Copia al Carbón
	userName			string	Nombre de la Copia al Carbón
initiatorInfo				object	Colección 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 documento a firmar
	fileKey			string	fileKey del documento 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 de recepción 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	¿Activar la firma digital? Por defecto, falso true-Activar, false-No activar
	authConfig			object	Método de verificación
		accessCode		object	Contraseña de acceso
			accessCode	string	Contraseña de acceso
			promptInfo	string	Mensaje de pista de la contraseña de acceso
		sms		object	Verificación OTP por SMS
			countryCode	string	Código internacional del país/región
			number	string	Número de teléfono móvil para la autenticación de identidad
		idVerification		object	Verificación de identidad
			name	string	Nombre completo en el documento de identidad del firmante
		emailAuth		object	Verificación OTP por correo electrónico
			authEmail	string	Dirección de correo electrónico para la verificación de identidad del firmante
		digitalId		object	Verificación electrónica de identidad
			authApp	string	Aplicación utilizada para la verificación electrónica de identidad
			idNumber	string	Número de documento de identidad del firmante para verificar
		whatsappAuth		object	Verificación OTP por WhatsApp
			countryCode	string	Código internacional del país/región
			number	string	Número de teléfono móvil para la autenticación de identidad
	signerStatus			int	Estado del firmante 0 - Pendiente de firma 1 - En proceso de 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,
                "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"
}