Consulter les détails du modèle d'enveloppe

Nom du paramètre

Type

Obligatoire

Description

envelopeTemplateId

string

true

ID du modèle d'enveloppe

queryComponents

boolean

false

Spécifie s'il faut interroger les informations des contrôles, par défaut false

true-Oui

false-Non

Nom du paramètre

Type

Description

code

int

Code métier, 0 indique le succès, tout autre code indique une erreur.

message

string

Informations métier

Veuillez vous baser sur le code pour identifier l'erreur. Ne vous fiez pas à la correspondance du message, car celui-ci peut être modifié.

data

object

Données métier

envelopeTemplateId

string

ID du modèle d'enveloppe

envelopeTemplateName

string

Nom du modèle de processus

envelopeTemplateStatus

int

État de disponibilité du modèle de processus

1-Activé

0-Désactivé

digitalSignature

boolean

Activer la signature numérique

true-Activé

false-Désactivé

signFiles

array

Informations sur le fichier

documentId

string

ID du fichier

fileName

string

Nom du fichier

participants

array

Participant

participantId

string

ID du participant

participantSetMode

string

Conditions de participation (mode de désignation des participants)

presetSigner-À préciser lors de l'utilisation d'un modèle (défini par l'utilisateur du modèle)

dedicateSigner-Membre fixe (codé en dur dans le modèle, non modifiable)

sender-Expéditeur

participantInfos

object

Participant individuel

userEmail

string

Adresse e-mail du signataire

phoneNumber

object

Numéro de téléphone, vide par défaut

Paramètre obligatoire pour les notifications par SMS, countryCode et number doivent tous deux être fournis

countryCode

string

Indicatif international du pays ou de la région, ne pas inclure le signe « + »

number

string

Aucune validation de format, longueur maximale de 13 caractères

userName

string

Nom de la personne

deliveryMethod

string

Mode de notification

auto-Envoyer une notification par e-mail lorsque userEmail est fourni, envoyer une notification SMS lorsque phoneNumber est fourni

none-Aucune notification

email-Envoyer une notification par e-mail

sms-Envoyer une notification SMS

WhatsApp-Envoyer une notification WhatsApp

customizeSettings

object

Configuration personnalisée

customizeMessage

string

Message dédié

Limite de caractères : 1000

notificationLanguage

string

Langue de notification, anglais par défaut

en-US Anglais

zh-CN Chinois simplifié

zh-Hant Chinois traditionnel

ja Japonais

es-MX Espagnol

pt-PT Portugais

th-TH thaï

id-ID indonésien

vi-VN vietnamien

ms-MY malais

fil-PH philippin

de-DE allemand

fr-FR français

ru-RU russe

it-IT italien

ko-KR coréen

signOrder

int

Ordre de signature

1-255 Répétition possible pour différents participants

willingnessAuthModes

string

Méthode d'intention du signataire (facultative), séparée par des virgules anglaises

noAuth-Aucune vérification

accessCode-Vérification par mot de passe de signature

sms-Vérification OTP SMS

idVerification-Vérification de pièce d'identité

emailAuth-Vérification OTP par e-mail

digitalId-Vérification d'identité numérique

whatsappAuth-Vérification OTP WhatsApp

accessCode

object

Configuration du code de signature, obligatoire lorsque authModes=accessCode

accessCode

string

Contenu du code, insensible à la casse, peut contenir des lettres et des chiffres, longueur maximale de 45 caractères

promptInfo

string

Message d'invite pour le code d'accès, ne doit pas contenir le code d'accès, longueur maximale de 30 caractères, obligatoire lorsque authModes=1.

sms

object

Vérification OTP SMS, obligatoire lorsque authModes=sms

countryCode

string

Indicatif international du pays ou de la région, sans inclure le signe « + »

number

string

Aucune vérification de format, la longueur est limitée à un maximum de 13 caractères

idVerification

object

Configuration de la vérification de pièce d'identité, obligatoire lorsque authModes=idVerification

name

string

Nom complet figurant sur la pièce d'identité du signataire, longueur maximale de 100 caractères

emailAuth

object

Vérification OTP par e-mail, obligatoire lorsque authModes=emailAuth

authEmail

string

Adresse e-mail de vérification d'identité du signataire

digitalId

array

Vérification d'identité électronique, obligatoire lorsque authModes=digitalId

authApp

string

Application utilisée pour la vérification d'identité électronique

singpass - Authentification via Singpass

iamsmart - Authentification via IAM Smart

idNumber

string

Numéro de pièce d'identité du signataire à vérifier

whatsappAuth

object

Vérification OTP WhatsApp, obligatoire lorsque authModes=whatsappAuth

countryCode

string

Code international du pays ou de la région, sans le caractère « + »

number

string

Aucune validation de format, longueur maximale limitée à 13 caractères

components

object

Informations sur le contrôle

copiers

array

Configurer les destinataires en copie

copierId

string

Identifiant du participant

editable

boolean

Autoriser la modification lors de la création

CCInfos

object

Informations des destinataires en copie

userEmail

string

Adresse e-mail

userName

string

Nom et prénom

customizeSettings

object

Configuration personnalisée

notificationSettings

object

Configuration personnalisée des notifications

notificationLanguage

string

Langue de notification, anglais par défaut

en-US Anglais

zh-CN Chinois simplifié

zh-Hant Chinois traditionnel

ja Japonais

ES-MX Espagnol

attachments

array

Informations sur la pièce jointe

editable

boolean

Autoriser la modification lors de l'initiation

fileKey

string

filekey de la pièce jointe

fileName

string

Nom de la pièce jointe

downloadUrl

string

Lien de téléchargement du fichier PDF du brouillon, valable 60 minutes.

components

array

Liste des contrôles

documentId

string

Clé du fichier du contrôle

componentId

string

ID du contrôle

componentKey

string

Clé du contrôle (identifiant du contrôle renseigné par l'utilisateur lors de la configuration du modèle de document)

componentName

string

Nom du contrôle

componentType

string

Type de contrôle

1, Texte

2, Nombre

3, Date

6, Zone de signature standard

8, Texte multiligne

9, Cocher

10, Choix unique

11, Image

14, Liste déroulante

15, Case à cocher

20，Zone de cachet

21, Zone de validation

22, Date de signature

23, E-mail

100, RMB

componentDefaultValue

string

Valeur par défaut du contrôle

componentPosition

object

Position du contrôle

componentPositionX

float

Coordonnée X de la position du contrôle

componentPositionY

float

Coordonnée Y de la position du contrôle

componentPageNum

int

Numéro de page du contrôle

componentSize

object

Dimensions du contrôle

componentWidth

int

Largeur du contrôle (distance des marges gauche et droite du rectangle, en px)

componentHeight

int

Hauteur du contrôle (distance des marges haut et bas du rectangle, en px)

componentTextFormat

object

Style de caractère du contrôle

font

int

Police de remplissage, par défaut 1,

1-Songti, 2-Xin Songti, 4-Heiti, 5-Kaiti

fontSize

float

Taille de police de remplissage, par défaut 12 pts-Xiao Si

42 pts-Chu Hao

36 pts-Xiao Chu

26 pts-Yi Hao

24 pts-Xiao Yi

22 pts-Er Hao

19 pts-Xiao Er

16 pts-San Hao

15 pts-Xiao San

14 pts-Si Hao

12 pts-Xiao Si

10,5 pts-Wu Hao

9 pts-Xiao Wu

textColor

string

Couleur de police, par défaut #000000 noir

bold

boolean

Activer le gras, par défaut false

true-Oui

false-Non

italic

boolean

Italique ou non, par défaut false

true-Oui

false-Non

horizontalAlignment

string

Alignement horizontal, par défaut 1-alignement à gauche

LEFT-alignement à gauche

CENTER-centrage

RIGHT-alignement à droite

verticalAlignment

string

Alignement vertical, par défaut 1-alignement en haut (s'applique au texte sur plusieurs lignes)

TOP-alignement en haut

MIDDLE-centrage

BOTTOM-alignement en bas

textLineSpacing

float

Interligne, par défaut 1.0, précision maximale d'un chiffre décimal, valeur maximale 2.0 (s'applique au texte sur plusieurs lignes)

required

boolean

Obligatoire ou non

true-Obligatoire

false-Facultatif

componentMaxLength

string

Longueur maximale de saisie du champ (nombre de caractères chinois)

componentSpecialAttribute

object

Propriétés spécifiques au champ

numberFormat

string

Format numérique (champ numérique)

Entier : 0

Une décimale : 0.0

Deux décimales : 0.00

dateFormat

string

Format de date (champ de date)

imageType

string

Type d'image (champ image)

IDCard_widthwise Carte d'identité Paysage Conserver les proportions

IDCard_longitudinal Carte d'identité Portrait Conserver les proportions

other Autre Ne pas conserver les proportions

options

array

Options (champ de sélection déroulante, champ à choix unique, champ à choix multiples)

optionOrder

int

Ordre des options

optionContent

string

Contenu de l'option

selected

boolean

Sélectionné par défaut

optionPositionX

float

Coordonnée X de l'élément enfant dans la bordure du contrôle parent

optionPositionY

float

Coordonnée Y de l'élément enfant dans la bordure du contrôle parent

optionWidth

float

Largeur de l'élément enfant

optionHeight

float

Hauteur de l'élément enfant

signField

object

Propriétés de la zone de signature et de cachet standard

fieldStyle

int32

Style de la zone de signature et de cachet

1-Zone de signature sur page unique

2-Zone de signature sur les bords des pages

sizeRule

int

Spécifications du cachet

1-Tamponner selon les spécifications réelles du cachet

2-Format personnalisé (adapté à la largeur et à la hauteur de la zone de signature)

movable

boolean

true-Déplaçable lors de la signature

false-Non déplaçable lors de la signature

stampField

object

Attributs de la zone de cachet

fieldStyle

int

Style de la zone de signature

1-Zone de signature sur une seule page

2-Zone de signature chevauchante

sizeRule

int

Spécifications du cachet

1-Appliquer le cachet selon les spécifications réelles

2-Espécifications personnalisées (adaptées aux dimensions de la zone de signature)

movable

boolean

true-Peut être déplacé lors de la signature

false-Ne peut pas être déplacé lors de la signature

signDateField

object

Attributs de la date de signature

dateFormat

string

Format de la date :

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

yyyy-MM-dd HH:mm:ss

approvalField

object

Attributs de la zone d'approbation

allowedOptions

array

Options permettant au signataire d'approuver, applicables lorsque fieldType est approval. Par défaut ["approve", "decline"]

approve-Accepter

decline-refus