Iniciar sobre rápido

Nombre del parámetro

Tipo

Obligatorio

Descripción

subject

string

true

Asunto del sobre

Ejemplo: “Offer Letter”

remark

string

false

Notas del sobre，Límite de longitud de 1000 caracteres

object

false

Operaciones permitidas para el firmante

boolean

false

¿Se permite al firmante transferir este sobre a otra persona para que lo firme? El valor predeterminado es falso.

true: permite que el firmante en el sobre tenga el poder de transferir el sobre a otros;

false: no permite que el firmante en el sobre tenga el poder de transferir el sobre a otros;

boolean

false

¿Se permite a la parte firmante modificar el nombre? Solo es efectivo para la firma de la plantilla, el valor predeterminado es falso.

true: permite que el firmante modifique el nombre

false: no permite que el firmante modifique el nombre

expireAfterSeconds

long

false

Tiempo de vencimiento del sobre, después de cuántos segundos el sobre vence

Rango de vencimiento: 86,400 segundos (1 día) ~ 7,776,000 segundos (90 días)

redirectUrl

string

false

Debe ser una dirección https válida

callBackUrl

string

false

Dirección de devolución de llamada (longitud 500), debe cumplir con la dirección del protocolo https.

sendLaterAfterSeconds

long

false

Admite el envío diferido por parte del usuario, en segundos

Rango de tiempo admitido: 3600 segundos (1 hora) ~ 259200 segundos (30 días)

CCInfos

array

false

Colección de información del destinatario de copia

userEmail

string

false

Dirección de correo electrónico del destinatario de copia

userName

string

false

Nombre del destinatario de copia, utilizado para mostrar el nombre del destinatario de copia en la página de firma y en el sobre.

【Atención】: No puede contener los siguientes 9 caracteres especiales: / \ : * " < > | ？ ni ningún emoji

customizeSettings

object

false

Configuración personalizada

notificationSettings

object

false

Configuración personalizada de notificaciones

notificationLanguage

string

false

Idioma de la notificación, por defecto toma la configuración de "Idioma de notificación predeterminado"

en-US Inglés

zh-CN Chino simplificado

zh-Hant Chino tradicional

ja-JP Japonés

es-MX Español

pt-PT Portugués
th-TH Tailandés
id-ID Indonesio
vi-VN Vietnamita
ms-MY Malayo
fil-PH Filipino
de-DE Alemán
fr-FR Francés
ru-RU Ruso
it-IT Italiano
ko-KR Coreano

signFiles

array

true

Colección de información de documentos firmados, el orden de visualización es el orden en que se agregan los documentos.

fileKey 

string

true

fileKey del documento firmado, solo se admite el formato PDF

attachments

array

false

Colección de archivos adjuntos del sobre, el orden de visualización es el orden en que se agregan los archivos.

fileKey 

string

false

fileKey del archivo

signerInfos

array

true

Colección de información del firmante

businessId

string

false

Número de negocio personalizado por el desarrollador, límite de longitud 500

string

false

userEmail

string

false

Dirección de correo electrónico del firmante

userName

string

true

Nombre del firmante, utilizado para mostrar el nombre del firmante en la página de firma y en el sobre.

【注】No puede contener los siguientes 9 caracteres especiales: / \ : * " < > | ？ ni ningún emoji

phoneNumber

object

false

Número de teléfono, por defecto está vacío

Es un parámetro obligatorio cuando se necesita enviar una notificación por SMS, se deben pasar tanto countryCode como number

countryCode

string

false

Código internacional del país o región, no es necesario incluir el "+"

number

string

false

Sin validación de formato, solo se limita la longitud máxima a 13 dígitos

customizeSettings

object

false

Configuración personalizada

notificationSettings

object

false

Configuración personalizada de la clase de notificación

customizeMessage

string

false

Notificación de mensaje exclusiva, límite de 200 caracteres

notificationLanguage

string

false

Idioma de la notificación, por defecto toma la configuración de "Idioma de notificación predeterminado"

en-US Inglés

zh-CN Chino simplificado

zh-Hant Chino tradicional

ja-JP Japonés

es-MX Español

pt-PT Portugués
th-TH Tailandés
id-ID Indonesio
vi-VN Vietnamita
ms-MY Malayo
fil-PH Filipino
de-DE Alemán
fr-FR Francés
ru-RU Ruso
it-IT Italiano
ko-KR Coreano

signOrder

int

true

Orden de firma del firmante, el mínimo es 1. Se puede especificar el mismo valor de orden para firmas desordenadas.

anySigner

boolean

false

¿Admite la firma de cualquier persona? El valor predeterminado es falso.

true-Solo una persona necesita firmar con el mismo signOrder

false-Todas las personas con el mismo signOrder deben firmar

authModes

string

false

Método de verificación, el valor predeterminado es noAuth

authConfig

object

false

Configuración del método de verificación

accessCode

object

false

Configuración de la contraseña de firma, cuando authModes=accessCodees obligatorio

accessCode

string

false

Contenido de la contraseña, no distingue entre mayúsculas y minúsculas, puede contener letras y números, longitud máxima de 45

promptInfo

string

false

Mensaje de información de la contraseña de acceso, no puede contener la contraseña de acceso, longitud máxima de 30, cuando authModes=accessCodees obligatorio. 

sms

object

false

Verificación OTP por SMS, cuando authModes=smses obligatorio

countryCode

string

false

Código internacional del país/región, no es necesario ingresar “+”

number

string

false

No se realiza la verificación de formato, solo se limita la longitud máxima a 13 dígitos

idVerification

object

false

Configuración de verificación de identificación, cuando authModes=idVerificationes obligatorio

name

string

false

Nombre completo en la identificación del firmante, longitud máxima de 100 caracteres

emailAuth

object

false

Verificación OTP por correo electrónico, cuando authModes=emailAuthes obligatorio

authEmail

string

false

Dirección de correo electrónico de verificación de identidad del firmante

digitalId

array

false

Verificación de identidad electrónica, obligatoria cuando authModes=digitalId

authApp

string

false

Aplicación utilizada para la verificación de identidad electrónica

singpass-Autenticación con Singpass

iamsmart-Autenticación con i AM Smart

idNumber

string

false

Número de identificación del firmante pendiente de verificación

Cuando authApp=singpassel formato de entrada es: letra mayúscula + 7 u 8 dígitos + letra mayúscula

Cuando authApp=iamsmartel formato de entrada es:

1. Una letra mayúscula (A-Z), o dos letras mayúsculas (AA-ZZ), como inicio de la secuencia;

2. Seguido de 6 dígitos;

3. Finalmente, un código de verificación, que puede ser un número (0-9) o una letra (A-Z). Ejemplo: A888888(A)

whatsappAuth

object

false

Verificación OTP de WhatsApp, obligatorio cuando authModes=whatsappAuth

countryCode

string

false

Código internacional del país/región, no es necesario incluir el signo “+”

number

string

false

No se realiza validación de formato, solo se limita la longitud máxima a 13 dígitos

digitalSignature

boolean

false

¿Activar firma digital? Predeterminado: false

true-Activar, false-No activar

freeFormSign

boolean

false

¿El firmante tiene libertad para firmar? El valor predeterminado es falso

Notas adicionales:

Cuando se selecciona freeFormSign como verdadero, no es necesario pasar otros parámetros bajo sealInfos. Si se pasan al mismo tiempo, freeFormSign tiene mayor prioridad que sealInfos, y los parámetros bajo sealInfos no tendrán efecto

【Atención】La firma libre no restringe la cantidad ni la posición de los sellos/firmas que el firmante puede arrastrar

sealInfos

array

false

Información de la tarea de firma

fileKey

string

true

fileKey del archivo de firma

signConfigs

array

false

Información de la ubicación del control. La información de la ubicación del control debe especificarse para realizar la firma electrónica.

fieldType

string

false

Tipo de control, el valor predeterminado es signature

signature-Control de firma

stamp-Control de sello

sizeRule

string

false

Método de visualización del tamaño del área de firma

originalSize-Sellar según el tamaño real de la firma/sello

targetSize-Ancho y alto personalizados del área de firma/sello

Cuando sizeRule, height y width están vacíos, el sello/firma se coloca según el tamaño real;

Cuando sizeRule está vacío y height y width no están vacíos, el sello/firma se coloca según el tamaño especificado;

Cuando sizeRule no está vacío, el sello/firma se coloca según el método de visualización especificado.

height

int

false

Altura del control de firma, aplicable cuando fieldType es signature/stamp, la unidad es px, solo se admiten enteros positivos, el valor predeterminado es auto (es decir, tamaño automático del sistema);

Cuando fieldType=signature, el rango configurable es de 20-250px;

Cuando fieldType=stamp, el rango configurable es de 30-280px;

width

int

false

Ancho del control de firma, aplicable cuando fieldType es signature/stamp, la unidad es px, solo se admiten enteros positivos, el valor predeterminado es auto (es decir, tamaño automático del sistema);

Cuando fieldType=signature, el rango configurable es de 20-250px;

Cuando fieldType=stamp, el rango configurable es de 30-280px;

signatureOptions

string

false

Opciones del control de firma. Solo aplicable cuando fieldType es signature

Parámetros de entrada:

template: Firma de plantilla

handDrawn: Firma dibujada a mano

upload: Cargar imagen de firma local

Se pueden seleccionar múltiples opciones, separadas por ",", la selección predeterminada es todas

movable

boolean

false

Permitir mover la ubicación al firmar, el valor predeterminado es falso

false: no permite que el firmante ajuste la ubicación de sus propios controles de firma

true: permite que el firmante ajuste la ubicación de sus propios controles de firma

allowedOptions

array

false

Opciones permitidas para que el firmante apruebe, aplicable cuando fieldType es approval. El valor predeterminado es ["approve", "decline"]

approve-Aprobar

decline-Rechazar

pageNo

string

false

Número de página de firma; los números de página consecutivos están conectados por "-", los números de página individuales están conectados por ","

Ejemplo: 1-3,6-10

posX

float

false

Coordenada del eje x

【注意】Si fieldType es signature, la posición de la coordenada se refiere al área de firmaEsquina inferior izquierda；

Si fieldType es stamp, la posición de la coordenada se refiere al área del selloPunto centralPosición

A partir del 3 de febrero de 2026, si fieldType es signature o stamp, la posición de la coordenada se refiere a la posición del punto central del área del sello.

posY

float

false

Coordenada del eje y

【Atención】Si fieldType es signature, la posición de la coordenada se refiere al área de la firmaEsquina inferior izquierda；

Si fieldType es stamp, la posición de la coordenada se refiere al área del selloPunto centralPosición

A partir del 3 de febrero de 2026, si fieldType es signature o stamp, la posición de la coordenada se refiere a la posición del punto central del área del sello.

fillConfigs

array

false

Rellena la información del control

fieldName

string

false

Nombre del control, límite de 128 caracteres

required

boolean

false

Si es obligatorio, obligatorio por defecto

true-Obligatorio

false-No obligatorio

fieldType

string

false

Tipo de control:

1-Texto de una sola línea

15-Casilla de verificación

textField

object

false

Propiedades del control de texto

overflowType

int

false

Solo aplica al texto, valor predeterminado 1

1-Reducir automáticamente el tamaño de la fuente

2-Restringir la entrada

minFontSize

float

false

Solo aplica al texto, solo aplica a overflowType=1, valor predeterminado 8

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

Ancho del control, valor predeterminado 160px

font

int

false

Solo aplica al texto, fuente, valor predeterminado 宋体 (Songti)

1-宋体 (Songti)

2-新宋体 (Xin Songti)

4-黑体 (Heiti)

5-楷体 (Kaiti)

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋 (Fangsong)

11-Georgia

12-Monospace

fontSize

float

false

Solo aplica al texto, tamaño de fuente, valor predeterminado 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

Solo aplica al texto, color hexadecimal, valor predeterminado negro #000

bold

boolean

false

Solo aplica al texto, indica si la fuente está en negrita, valor predeterminado false

verdadero-Negrita

falso-Sin negrita

italic

boolean

false

Solo aplica al texto, si es cursiva, por defecto falso

verdadero-Cursiva

falso-Sin cursiva

underline

boolean

false

Solo aplica al texto, si la fuente tiene subrayado, por defecto falso

verdadero-Añadir subrayado

falso-No añadir subrayado

lineThrough

boolean

false

Solo aplica al texto, si se añade tachado, por defecto falso

verdadero-Añadir tachado

falso-No añadir tachado

horizontalAlignment

string

false

Solo aplica al texto, formato de centrado horizontal, por defecto left

LEFT-A la izquierda

CENTER-Centrado

RIGHT-A la derecha

tickBoxField

object

false

Propiedades de la casilla de verificación

tickOptions

array

false

Solo aplica a tickBox, el valor predeterminado es 1

1-Marca

2-Cruz

posX

float

false

Coordenada X de la posición del control

posY

float

false

Coordenada Y de la posición del control

pageNo

string

false

Número de página donde se encuentra el control

signDateConfigs

array

false

Información de la posición de la fecha de firma

movable

boolean

false

Permitir mover la posición al firmar, el valor predeterminado es false

false-No permitir que el firmante ajuste la posición de su propio control de firma

true-Permitir que el firmante ajuste la posición de su propio control de firma

pageNo

string

false

Número de página de firma; los números de página consecutivos se conectan con "-", los números de página individuales se conectan con ","，Ejemplo: 1-3, 6-10;

Si no es continuo, ingrese "," para dividir.

posX

float

false

Desplazamiento del eje x, la esquina inferior izquierda de la página es el origen de las coordenadas

posY

float

false

Desplazamiento del eje Y, la esquina inferior izquierda de la página es el origen de las coordenadas

signDateFormat

string

false

Formato de fecha de firma, el formato predeterminado es aaaa-MM-dd

Formatos admitidos:

aaaa年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy

Nombre del parámetro

Tipo

Descripción

envelopeId

string

ID del sobre

CCInfos

array

Colección de información de copia al carbón

userEmail

string

Dirección de correo electrónico de la persona en copia al carbón

userName

string

Nombre de la persona en copia al carbón

signFiles

array

Colección de información del archivo de firma

fileKey

string

fileKey del archivo de firma

attachments

array

Colección de archivos adjuntos del sobre

fileKey

string

Archivo fileKey

signerInfos

array

Información de firma

businessId

string

Número de negocio personalizado del desarrollador, longitud limitada a 500

userEmail

string

Dirección de correo electrónico del firmante

userName

string

Nombre del firmante

signOrder

int

Orden de firma del firmante, el mínimo es 1

accessCode

string

Contraseña de acceso a la página de firma