O download em pacote dos arquivos do envelope só é suportado quando o envelope estiver concluído.
Parâmetros de solicitação
Nome do parâmetro
Tipo
Obrigatório
Descrição
envelopeId
string
true
ID do envelope
downloadType
string
false
Tipo de formato de download do arquivo:
zip (padrão): retorna o link para download do arquivo compactado
list: retorna a lista de arquivos
Exemplo de solicitação
GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list
Parâmetros de resposta
Nome do parâmetro
Tipo
Descrição
envelopeId
string
ID do envelope
envelopeStatus
int
Status do envelope
0-Criado (rascunho)
1-Em assinatura
2-Concluído
3-Expirado
5-Revogado
downloadUrl
string
URL de download do arquivo
【Atenção】Válido por 30 minutos. Após expirar, solicite novamente à API para obter o URL de download.
Retornado quando downloadType=zip
envelopeFiles
array
Conjunto de arquivos do envelope
Conjunto de arquivos do envelope
【Atenção】Retornado quando downloadType=list
fileType
string
Tipo de arquivo
CONTRACT-Documento de assinatura
ATTACHMENT-Anexo
CERTIFICATE-Certificado
COMBINED-Arquivo PDF que mescla o 'documento de assinatura' e o 'comprovante de conclusão da assinatura', retornado quando a opção 'download combinado de arquivos do envelope' estiver habilitada
fileName
string
Nome do arquivo
downloadUrl
string
Endereço de download do arquivo (válido por 60 minutos)