Central do desenvolvedor

Descarregar ficheiro

GET /esignglobal/v1/envelope/files/download

Descrição da Interface

Apenas quando o envelope estiver concluído, é suportado o download em pacote dos ficheiros dentro do envelope.

Parâmetros de Requisição

Nome do Parâmetro

Tipo

Obrigatório

Descrição

envelopeId

string

true

ID do Envelope

downloadType

stringfalse

Tipo de formato de download de ficheiro: 

  • zip (predefinição): Devolve o link de download do pacote comprimido
  • list: Devolve a lista de ficheiros 

Exemplo de Requisiçã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

Estado do Envelope

0- Criado (Rascunho)

1- A ser assinado

2- Concluído

3- Expirado

4- Rejeitado

5- Revogado

downloadUrl

string

Endereço de Download do Ficheiro

【注意】Válido por 30 minutos, solicite novamente a interface para obter o endereço de download após a expiração

Retornado quando downloadType=zip

envelopeFiles

array

Coleção de Ficheiros do Envelope

Coleção de Ficheiros do Envelope

【注意】Retornado quando downloadType=list

 

fileType

string

Tipo de ficheiro

CONTRACT- Documento assinado

ATTACHMENT- Anexo

CERTIFICATE- Certificado

 

fileName

string

Nome do ficheiro

 

downloadUrl

string

Endereço de download do ficheiro (válido por 60 minutos)

Exemplo de resposta

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

 

Descrição da Interface
Parâmetros de Requisição
Exemplo de Requisição
Parâmetros de Resposta
Exemplo de resposta