Baixar arquivo

GET /esignglobal/v1/envelope/files/download

Descrição da interface

Durante ou após a conclusão da assinatura do envelope, é possível baixar os arquivos contidos no envelope. O download durante o processo de assinatura está sujeito às configurações de download do fluxo, permissões de download e regras de visibilidade dos arquivos; se for necessário aplicar uma marca d'água assíncrona aos arquivos durante a assinatura, a interface retornará um ID de tarefa de download, e o cliente poderá obter os resultados do arquivo por meio da interface de consulta de tarefas de download ou do callback de conclusão da tarefa de download.

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 de 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
taskId		string	ID da tarefa de download. Retornado apenas quando o envelope estiver em assinatura e os arquivos exigirem composição assíncrona com marca d'água. [Nota] Ao retornar o taskId, os campos de resultado dos arquivos como downloadUrl e envelopeFiles não são retornados.
downloadUrl		string	URL de download do arquivo [Nota] Válido por 30 minutos; após a expiração, solicite novamente a interface para obter o URL de download. Retornado quando downloadType=zip e os resultados dos arquivos podem ser retornados de forma síncrona; não retornado ao retornar o taskId.
envelopeFiles		array	Conjunto de arquivos do envelope [Nota] Retornado quando downloadType=list e os resultados dos arquivos podem ser retornados de forma síncrona; não retornado ao retornar o taskId.
	fileType	string	Tipo de arquivo CONTRACT- Documento assinado ATTACHMENT- Anexo CERTIFICATE- Certificado COMBINED- Arquivo PDF que combina o "Documento Assinado" e o "Comprovante de Conclusão da Assinatura", retornado quando a opção "Baixar arquivos do envelope combinados" estiver ativada
	fileName	string	Nome do arquivo
	downloadUrl	string	URL de download do arquivo (válido por 60 minutos)

Exemplo de resposta

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}

Quando o documento estiver em processo de assinatura e exigir composição assíncrona com marca d'água, o exemplo de resposta é o seguinte:

{
    "code": "0",
    "data": {
      "envelopeId": "xxxx",
      "envelopeStatus": 1,
      "taskId": "task1234567890"
  },
  "message": "success"
}