Iniciar Envelope Rapidamente

Nome do Parâmetro

Tipo

Obrigatório

Descrição

subject

string

true

Assunto do Envelope

Exemplo: “Offer Letter”

remark

string

false

Observações do Envelope，Limite de comprimento de 1000 caracteres

object

false

Operações permitidas para o signatário

boolean

false

Se o signatário pode encaminhar este envelope para outra pessoa assinar, o padrão é falso

true - Permite que o signatário no envelope tenha o poder de encaminhar o envelope para outra pessoa;

false - Não permite que o signatário no envelope tenha o poder de encaminhar o envelope para outra pessoa;

boolean

false

Se a parte signatária pode modificar o nome, válido apenas para assinaturas de modelo, o padrão é falso

true - Permite que o signatário modifique o nome

false - Não permite que o signatário modifique o nome

expireAfterSeconds

long

false

Tempo de expiração do envelope, após quantos segundos o envelope expira

Intervalo de expiração: 86.400 segundos (1 dia) ~ 7.776.000 segundos (90 dias)

redirectUrl

string

false

Deve ser um endereço https válido

callBackUrl

string

false

Endereço de retorno de chamada (comprimento 500), deve estar em conformidade com o endereço do protocolo https.

sendLaterAfterSeconds

long

false

Suporta o envio atrasado pelo utilizador, em segundos

Intervalo de tempo suportado: 3600 segundos (1 hora) ~ 259200 segundos (30 dias)

CCInfos

array

false

Conjunto de informações do destinatário em cópia

userEmail

string

false

Endereço de e-mail do destinatário em cópia

userName

string

false

Nome do destinatário em cópia, usado para exibir o nome do destinatário em cópia na página de assinatura e no envelope.

【Atenção】：Não pode conter os seguintes 9 caracteres especiais: / \ : * " < > | ？e todos os emojis

customizeSettings

object

false

Configuração personalizada

notificationSettings

object

false

Configuração personalizada de notificação

notificationLanguage

string

false

Idioma da notificação, o padrão é inglês

en-US Inglês

zh-CN Chinês simplificado

zh-Hant Chinês tradicional

ja-JP Japonês

ES-MX Espanhol

signFiles

array

true

Coleção de informações de documentos de assinatura, a ordem de exibição é a ordem em que os arquivos são adicionados.

fileKey 

string

true

fileKey do documento de assinatura, suporta apenas o formato PDF

attachments

array

false

Coleção de anexos de envelope, a ordem de exibição é a ordem em que os arquivos são adicionados.

fileKey 

string

false

fileKey do ficheiro

signerInfos

array

true

Coleção de informações do signatário

businessId

string

false

Número de negócio personalizado pelo desenvolvedor, limite de comprimento de 500

string

false

userEmail

string

true

Endereço de e-mail do signatário

userName

string

true

Nome do signatário, usado para exibir o nome do signatário na página de assinatura e no envelope.

【注】Não pode conter os seguintes 9 caracteres especiais: / \ : * " < > | ？e todas as expressões emoji

phoneNumber

object

false

Número de telefone, o padrão é vazio

É um parâmetro obrigatório quando é necessário enviar uma notificação por SMS, tanto countryCode quanto number precisam ser passados

countryCode

string

false

Código internacional do país/região, não precisa passar “+”

number

string

false

Sem verificação de formato, apenas limita o comprimento máximo a 13 dígitos

customizeSettings

object

false

Configuração personalizada

notificationSettings

object

false

Configuração personalizada de notificações

customizeMessage

string

false

Notificações de mensagens exclusivas, limite de 200 caracteres

notificationLanguage

string

false

Idioma da notificação, o padrão é inglês

en-US Inglês

zh-CN Chinês Simplificado

zh-Hant Chinês Tradicional

ja Japonês

ES-MX Espanhol

signOrder

int

true

Ordem de assinatura do signatário, o mínimo é 1. Assinaturas não ordenadas podem especificar o mesmo valor de ordem.

anySigner

boolean

false

Se suporta a assinatura de qualquer pessoa, o padrão é false

true-Apenas uma pessoa no mesmo signOrder precisa assinar

false-Todas as pessoas no mesmo signOrder precisam assinar

authModes

string

false

Método de verificação, o padrão é noAuth

authConfig

object

false

Definições do método de verificação

accessCode

object

false

Definições da palavra-passe de assinatura, obrigatório quando authModes=accessCode时必填

accessCode

string

false

Conteúdo da palavra-passe, não sensível a maiúsculas e minúsculas, pode conter letras e números, limite de comprimento de 45

promptInfo

string

false

Informações de aviso da palavra-passe de acesso, não pode conter a palavra-passe de acesso, limite de comprimento de 30, obrigatório quando authModes=1. 

sms

object

false

Verificação OTP por SMS, obrigatório quando authModes=sms时必填

countryCode

string

false

Código internacional do país/região, não é necessário introduzir “+”

number

string

false

Não efetua verificação de formato, apenas limita o comprimento máximo a 13 dígitos

idVerification

object

false

Definições de verificação de documento de identificação, obrigatório quando authModes=idVerification时必填

name

string

false

Nome completo no documento de identificação do signatário, comprimento máximo de 100 caracteres

emailAuth

object

false

Validação OTP por e-mail, quando authModes=emailAuthé obrigatório

authEmail

string

false

Endereço de e-mail de verificação de identidade do signatário

digitalId

array

false

Autenticação de identidade eletrónica, obrigatória quando authModes=digitalId

authApp

string

false

APP utilizada para autenticação de identidade eletrónica

singpass - Utilizar o Singpass para autenticação

idNumber

string

false

Número do documento de identificação do signatário a ser verificado

digitalSignature

boolean

false

Se a assinatura digital está ativada, predefinição é false

true - Ativar, false - Não ativar

freeFormSign

boolean

false

Se o signatário pode assinar livremente, valor predefinido é false

Nota adicional:

Quando freeFormSign é definido como true, não é necessário transmitir outros parâmetros em sealInfos. Se forem transmitidos ao mesmo tempo, a prioridade de freeFormSign é superior a sealInfos, e os parâmetros em sealInfos não terão efeito

[Atenção]Assinatura livre significa que não há restrições ao número e posição de selos/assinaturas que o signatário pode arrastar

sealInfos

array

false

Assinar Informação da Tarefa

fileKey

string

true

Assinar ficheiro fileKey

signConfigs

array

false

Informação da localização do controlo, a informação da localização do controlo deve ser especificada para realizar a assinatura eletrónica.

fieldType

string

false

Tipo de controlo, predefinição é signature

signature- Controlo de assinatura

stamp- Controlo de selo

sizeRule

string

false

Método de exibição do tamanho da área de assinatura

originalSize- Selar de acordo com o tamanho real da assinatura/selo

targetSize- Largura e altura personalizadas da área de assinatura/selo

Quando sizeRule, height e width estão todos vazios, o selo é aplicado de acordo com o tamanho real da assinatura/selo;

Quando sizeRule está vazio e height e width não estão vazios, o selo é aplicado de acordo com o tamanho especificado;

Quando sizeRule não está vazio, o selo é aplicado de acordo com o método de exibição especificado.

height

int

false

Altura do controlo de assinatura, aplicável a fieldType como signature/stamp, unidade em px, suporta apenas a passagem de inteiros positivos, predefinição é auto (ou seja, tamanho automático do sistema);

Quando fieldType=signature, o intervalo configurável é 20-250px;

Quando fieldType=stamp, o intervalo pode ser definido como 30-280px;

width

int

false

Largura do controlo de assinatura, aplicável quando fieldType é signature/stamp, a unidade é px, apenas suporta a introdução de inteiros positivos, por defeito auto (ou seja, tamanho automático do sistema);

Quando fieldType=signature, o intervalo pode ser definido como 20-250px;

Quando fieldType=stamp, o intervalo pode ser definido como 30-280px;

signatureOptions

string

false

Opções de controlo de assinatura. Apenas aplicável quando fieldType é signature

Pode introduzir parâmetros:

template: Assinatura de modelo

handDrawn: Assinatura desenhada à mão

upload: Carregar imagem de assinatura local

Pode selecionar várias opções, separadas por ",", por defeito todas selecionadas

movable

boolean

false

Permitir mover a posição ao assinar, por defeito false

false - Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

true - Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

allowedOptions

array

false

Opções que o signatário pode aprovar, aplicável quando fieldType é approval. O padrão é ["approve", "decline"]

approve- Concordo

decline- Rejeitar

pageNo

string

false

Páginas a assinar; páginas consecutivas são ligadas com "-", páginas individuais são ligadas com ","

Exemplo: 1-3,6-10

posX

float

false

Coordenada do eixo x

【Atenção】Se fieldType for signature, a posição das coordenadas refere-se à área de assinaturaCanto inferior esquerdo；

Se fieldType for stamp, a posição das coordenadas refere-se à área de seloPonto centralPosição

A partir de 3 de fevereiro de 2026, se fieldType for signature ou stamp, a posição das coordenadas refere-se à posição do ponto central da área de selo.

posY

float

false

Coordenada do eixo y

【Atenção】Se fieldType for signature, a posição das coordenadas refere-se à área de assinaturaCanto inferior esquerdo；

Se fieldType for stamp, a posição das coordenadas refere-se à área de seloPonto centralPosição

A partir de 3 de fevereiro de 2026, para fieldType do tipo signature ou stamp, a posição das coordenadas refere-se à posição do ponto central da área de selagem.

fillConfigs

array

false

Preencher informações do controlo

fieldName

string

false

Nome do controlo, limite de 128 caracteres

required

boolean

false

Obrigatório ou não, obrigatório por defeito

true-obrigatório

false-não obrigatório

fieldType

string

false

Tipo de controlo:

1-Texto de linha única

15-Caixa de verificação

textField

object

false

Propriedades do controlo de texto

overflowType

int

false

Apenas eficaz para texto, 1 por defeito

1-Reduzir automaticamente o tamanho da fonte

2-Restringir a entrada

minFontSize

float

false

Apenas eficaz para texto, apenas eficaz para overflowType=1, 8 por defeito

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

width

int

false

Largura do controlo, predefinição 160px

font

int

false

Aplica-se apenas ao texto, tipo de letra, predefinição 宋体

1-宋体

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

Aplica-se apenas ao texto, tamanho do tipo de letra, predefinição 12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

textColor

string

false

Aplica-se apenas ao texto, cor hexadecimal, predefinição preto #000

bold

boolean

false

Aplica-se apenas ao texto, se o tipo de letra está a negrito, predefinição false

true-Negrito

false-Não negrito

italic

boolean

false

Aplica-se apenas ao texto, se é itálico, predefinição false

true-Itálico

false-Não itálico

underline

boolean

false

Aplica-se apenas ao texto, se a fonte deve ser sublinhada, por defeito é falso

true - Adicionar sublinhado

false - Não adicionar sublinhado

lineThrough

boolean

false

Aplica-se apenas ao texto, se deve adicionar um traço de eliminação, por defeito é falso

true - Adicionar traço de eliminação

false - Não adicionar traço de eliminação

horizontalAlignment

string

false

Aplica-se apenas ao texto, formato de alinhamento horizontal, por defeito é left

LEFT - À esquerda

CENTER - Centrado

RIGHT - À direita

tickBoxField

object

false

Atributos da caixa de verificação

tickOptions

array

false

Aplica-se apenas ao tickBox, por defeito é 1

1 - Visto

2 - Cruz

posX

float

false

Coordenada X horizontal da posição do controlo

posY

float

false

Coordenada Y da posição do controlo

pageNo

string

false

Número da página onde o controlo se encontra

signDateConfigs

array

false

Informação da posição da data de assinatura

movable

boolean

false

Permitir mover a posição ao assinar, por defeito é falso

false - Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

true - Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura

pageNo

string

false

Número da página de assinatura; páginas contínuas são ligadas com "-", páginas individuais são ligadas com ","，Exemplo: 1-3, 6-10;

Se não for contínuo, passe "," para separar.

posX

float

false

Deslocamento do eixo x, o canto inferior esquerdo da página é a origem das coordenadas

posY

float

false

Deslocamento do eixo y, o canto inferior esquerdo da página é a origem das coordenadas

signDateFormat

string

false

Formato da data de assinatura, o formato padrão é aaaa-MM-dd

Formatos suportados:

aaaa年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Nome do parâmetro

Tipo

Descrição

envelopeId

string

ID do envelope

CCInfos

array

Conjunto de informações do destinatário em cópia

userEmail

string

Endereço de e-mail do destinatário em cópia

userName

string

Nome do destinatário em cópia

signFiles

array

Conjunto de informações do documento assinado

fileKey

string

fileKey do documento assinado

attachments

array

Conjunto de anexos do envelope

fileKey

string

fileKey do ficheiro

signerInfos

array

Informação de assinatura

businessId

string

Número de negócio personalizado do desenvolvedor, limite de comprimento de 500

userEmail

string

Endereço de e-mail do signatário

userName

string

Nome do signatário

signOrder

int

Ordem de assinatura do signatário, o mínimo é 1

accessCode

string

Palavra-passe de acesso à página de assinatura