eSign.AIeSign.AI
Centre de développement

Initier rapidement un enveloppe

POST /esignglobal/v1/envelope/createAndStart

Description de l'interface

Création rapide d'un enveloppe, incluant la création de l'enveloppe, l'ajout de documents à signer et l'ajout de signataires.

  • Prise en charge de l'activation automatique: Après un appel réussi de l'interface, l'enveloppe est créée et activée avec succès, puis elle commence automatiquement à circuler.
  • Prise en charge de la fin automatique: Une fois que toutes les parties prenantes ont signé, l'enveloppe se termine automatiquement.

 

Paramètres de requête

Nom du paramètre

Type

Obligatoire

Description

subject

string

true

Sujet de l'enveloppe

Exemple : « Lettre d'offre »

remark

string

false

Remarque sur l'enveloppe, limite de longueur de 1000 caractères

signerSettings

object

false

Opérations autorisées pour le signataire

 

allowTransfer

boolean

false

Autoriser le signataire à transférer l'enveloppe à une autre personne pour signature, par défaut false

true - Autorise les signataires de l'enveloppe à transférer celle-ci à d'autres personnes ;

false - N'autorise pas les signataires de l'enveloppe à la transférer à d'autres personnes ;

 

allowModifyName

boolean

false

Autoriser le signataire à modifier son nom, applicable uniquement aux signatures de modèle, par défaut false

true - Autorise le signataire à modifier son nom

false - N'autorise pas le signataire à modifier son nom

expireAfterSeconds

long

false

Date d'expiration de l'enveloppe, délai en secondes après lequel l'enveloppe expire

Plage d'expiration : 86 400 secondes (1 jour) à 7 776 000 secondes (90 jours)

redirectUrl

string

false

Doit être une adresse https valide

callBackUrl

string

false

Adresse de rappel (longueur 500), doit respecter le protocole https.

sendLaterAfterSeconds

long

false

Prend en charge le report de l'envoi par l'utilisateur, exprimé en secondes

Plage de temps prise en charge : 3 600 secondes (1 heure) à 259 200 secondes (30 jours)

autoFinish

boolean

false

Contrôle si l'enveloppe se termine automatiquement, par défaut true

true- Fin automatique de l'enveloppe

false- Fin manuelle de l'enveloppe

CCInfos

array

false

Ensemble des informations sur les destinataires en copie

 

userEmail

string

false

Adresse e-mail du destinataire en copie

 

userName

string

false

Nom du destinataire en copie, utilisé pour afficher le nom du destinataire en copie sur la page de signature et sur l'enveloppe.

[Remarque] : Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > | ? ainsi que tous les emojis

 

ccOrder

int

false

Position dans l'ordre du destinataire en copie lors du processus de signature, partageant l'ordre avec signOrder des signataires. Si non transmis, la logique de notification de copie existante est conservée.

 

customizeSettings

object

false

Configuration personnalisée

 

 

notificationSettings

object

false

Configuration personnalisée pour les notifications

 

 

 

notificationLanguage

string

false

Langue de notification, par défaut utilise la configuration « Langue de notification par défaut »

en-US Anglais

zh-CN Chinois simplifié

zh-Hant Chinois traditionnel

ja-JP 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

signFiles

array

true

Ensemble d'informations sur les documents à signer, affiché dans l'ordre d'ajout des documents.

 

fileKey 

string

true

fileKey du document à signer, uniquement au format PDF

 documentFieldsarrayfalseListe des contrôles dimensionnels de document. Utilisé pour ajouter des contrôles dimensionnels de document non liés à un signataire sur un document spécifié.

 

 

fieldType

string

false

Type de contrôle. Indiquez eMeterai pour le contrôle de timbre fiscal indonésien.

 

 

pageNo

string

false

Numéro de page où se trouve le contrôle. Le contrôle de timbre fiscal indonésien ne prend en charge que la spécification d'une seule page ; vous devez transmettre un numéro de page unique, les formats de pages multiples continues ou discontinues tels que 1-3 ou 1,3 ne sont pas pris en charge.

  posXfloatfalseDécalage selon l'axe x, l'origine des coordonnées étant le coin inférieur gauche de la page. La plage de coordonnées est identique à celle des autres contrôles.
  posYfloatfalseDécalage de l'axe y, l'origine des coordonnées est le coin inférieur gauche de la page. La plage de coordonnées est cohérente avec celle des autres composants.

attachments

array

false

Ensemble des pièces jointes sous forme d'enveloppe, l'ordre d'affichage correspond à l'ordre d'ajout des fichiers.

 

fileKey 

string

false

Clé du fichier fileKey

signerInfos

array

true

Ensemble des informations sur les signataires

 

businessId

string

false

Numéro d'identification métier personnalisé par le développeur, limite de longueur : 500 caractères

 

roleTypes

array

false

Mode d'action du signataire, valeur par défaut :["sign", "fill"]

fill-Remplir

sign-Signer

 deliveryMethods

string

false

Mode de notification, valeur par défaut : auto

auto- Envoie une notification par e-mail lorsque userEmail est fourni, envoie une notification par SMS lorsque phoneNumber est fourni

none- N'envoie pas de notification

email- Envoie une notification par e-mail

sms- Envoie une notification par SMS

WhatsApp- Envoie une notification WhatsApp

 

userEmail

string

false

Adresse e-mail du signataire

 

userName

string

true

Nom du signataire, affiché sur la page de signature et dans l'enveloppe.

[Remarque] Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > | ? ainsi que tous les emojis

 minimumReadingDurationintfalseDurée du compte à rebours obligatoire pour la lecture sur la page de configuration, valeur par défaut 0 (unité : secondes, maximum 999)
0 ou omission signifie désactivé, aucun compte à rebours de lecture requis
 readToEndRequiredbooleanfalseIndique si la lecture jusqu'au bout est obligatoire. Valeur par défaut : false ;
true indique activé, false ou omission indique désactivé.

 

phoneNumber

object

false

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

Paramètre obligatoire lors de notifications par SMS ; countryCode et number doivent tous deux être fournis

 

 

countryCode

string

false

Code international du pays/région, sans le « + »

 

 

number

string

false

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

 

customizeSettings

object

false

Configuration personnalisée

 

 

notificationSettings

object

false

Configuration personnalisée pour les notifications

 

 

 

customizeMessage

string

false

Notification de message dédié, limite de 200 caractères

   

notificationLanguage

string

false

Langue de notification, utilise par défaut la configuration « Langue de notification par défaut »

en-US Anglais

zh-CN chinois simplifié

zh-Hant chinois traditionnel

ja-JP 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

true

Ordre de signature du signataire, minimum 1. Pour les signatures non ordonnées, une même valeur d'ordre peut être spécifiée.

 

signTaskSuspend

boolean

false

Indique s'il faut définir un nœud de blocage de processus avant ce point de signature, par défaut false. true : définit un nœud de blocage ; false : ne définit pas de nœud de blocage. La configuration du blocage doit être cohérente au sein d'un groupe de signatures en OU partageant le même signOrder.

 

suspensionKey

string

false

Identifiant du nœud de blocage, maximum 500 caractères, unique dans le même enveloppe. Obligatoire lorsque signTaskSuspend=true ; interdit lorsque signTaskSuspend=false ou non fourni.

 

suspendReason

string

false

Raison du blocage, obligatoire si fournie, maximum 50 caractères. Autorisé uniquement lorsque signTaskSuspend=true ; omis par défaut pour indiquer qu'une attente du traitement par un système externe est nécessaire. Interdit lorsque signTaskSuspend=false ou non fourni.

 

anySigner

boolean

false

Indique si la signature par toute personne est autorisée, par défaut false

true- Au moins une personne parmi celles ayant le même signOrder doit signer

false- Toutes les personnes ayant le même signOrder doivent signer

 

authModes

string

false

Mode de vérification, par défaut noAuth

noAuth- Aucune vérification

accessCode- Vérification par mot de passe de signature

sms- Vérification OTP par SMS

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

emailAuth- Vérification OTP par e-mail

digitalId- Vérification d'identité électronique

whatsappAuth- Vérification OTP par WhatsApp

 

authConfig

object

false

Paramètres du mode de vérification

 

 

accessCode

object

 

false

Paramètres du mot de passe de signature, obligatoire lorsque authModes=accessCode, obligatoire

 

 

 

accessCode

string

false

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

   

promptInfo

string

false

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

 

 

sms

object

false

Vérification OTP par SMS, obligatoire lorsque authModes=sms, obligatoire

 

 

 

countryCode

string

false

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

 

 

 

number

string

false

Aucune validation de format, seule la longueur maximale de 13 caractères est imposée

 

 

idVerification

object

false

Paramètres de vérification par pièce d'identité, obligatoire lorsque authModes=idVerification, obligatoire

 

 

 

name

string

false

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

  

emailAuth

object

false

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

  

 

authEmail

string

false

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

 

 

digitalId

array

false

Authentification électronique, obligatoire lorsque authModes=digitalId

 

 

 

authApp

string

false

Application utilisée pour l'authentification électronique

singpass- Authentification via Singpass

iamsmart- Authentification via i AM Smart

 

 

 

idNumber

string

false

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

Lorsque authApp=singpass, la règle de saisie est : une lettre majuscule + 7 ou 8 chiffres + une lettre majuscule

Lorsque authApp=iamsmart, la règle de saisie est :

1. Une lettre majuscule (A-Z) ou deux lettres majuscules (AA-ZZ) en tant que début de séquence ;

2. Suivi de 6 chiffres ;

3. Terminé par un code de contrôle, qui peut être un chiffre (0-9) ou une lettre (A-Z). Exemple : A888888(A)

 

 

whatsappAuth

object

false

Vérification OTP WhatsApp, obligatoire lorsque authModes=whatsappAuth

 

 

 

countryCode

string

false

Code international du pays/région, sans inclure le « + »

 

 

 

number

string

false

Aucune validation de format, seule la longueur maximale de 13 caractères est limitée

 

digitalSignature

boolean

false

Activer ou non la signature numérique, par défaut false

true-activer, false-désactiver

 

tsp

string

false

Sélectionner le TSP utilisé par le signataire, par défaut false.

Si non défini, le signataire choisit librement le TSP à utiliser. Les valeurs possibles sont :

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni

belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia

estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom

harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId

mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign

smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe

certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha

 

freeFormSign

boolean

false

Le signataire peut-il apposer son cachet/scellé librement, valeur par défaut false

Remarques complémentaires :

Lorsque freeFormSign est défini sur true, aucun autre paramètre sous sealInfos n'est requis. Si les deux sont fournis simultanément, freeFormSign a priorité sur sealInfos et les paramètres de sealInfos ne seront pas appliqués.

[Attention]La signature libre signifie qu'il n'y a aucune restriction sur le nombre et la position des cachets/signatures que le signataire peut faire glisser dans le document.

 

documentVisibility

object

false

Configuration de la visibilité des fichiers, tous visibles par défaut.

 

 

documentViewType

string

false

Stratégie de visibilité, par défaut all ; all indique que tous les documents de l'enveloppe peuvent être consultés, limited indique que seuls les documents signés par l'utilisateur et les documents supplémentaires autorisés peuvent être consultés.

 

 

viewableFileKeys

array

false

Liste des fileKey supplémentaires que la partie signataire est autorisée à consulter ; uniquement applicable et effective lorsque documentViewType=limited.

 

sealInfos

array

false

Informations sur la tâche de signature

 

 

fileKey

string

true

fileKey du document signé

 

 

signConfigs

array

false

Informations de position du contrôle. Les informations de position doivent être spécifiées pour effectuer la signature électronique.

 

 

 

fieldType

string

false

Type de contrôle, par défaut « signature »

signature- Contrôle de signature

stamp- Contrôle de sceau

approval- Contrôle d'approbation

   

required

boolean

false

Champ obligatoire ou non, par défaut obligatoire

true- Obligatoire

false- Non obligatoire

   

signFieldStyle

string

false

Mode d'apposition du contrôle de signature, par défaut « normalSeal ».

normalSeal- Signature et sceau ordinaires

pagingSeal- Sceau de reliure

Seuls les contrôles de signature et de sceau prennent en charge la configuration du sceau de reliure.

   

pagingSealMode

string

false

Plage de pages pour l'apposition du sceau de reliure, par défaut « all ».

all- Toutes les pages

assignedPages- Pages spécifiques

even-Pages paires

odd-Pages impaires

Spécifiable uniquement lorsque signFieldStyle=pagingSeal.

   

sizeRule

string

false

Mode d'affichage des dimensions de la zone de signature

originalSize-Placer le sceau selon les dimensions réelles de la signature/du sceau

targetSize-Dimensions personnalisées (largeur et hauteur) de la zone de signature/du sceau

Lorsque sizeRule, height et width sont tous vides, le sceau est placé selon les dimensions réelles de la signature/du sceau ;

Lorsque sizeRule est vide mais que height et width ne le sont pas, le sceau est placé selon les dimensions spécifiées ;

Lorsque sizeRule n'est pas vide, le sceau est placé selon le mode d'affichage spécifié ;

Le sceau de recouvrement n'a pas besoin de ce paramètre ; il est placé uniquement selon les dimensions réelles.

 

 

 

height

int

false

Hauteur du contrôle de signature, applicable lorsque fieldType est signature/stamp, exprimée en px. Seuls les entiers positifs sont acceptés. La valeur par défaut est auto (taille automatique par le système) ;

Lorsque fieldType=signature, la plage autorisée est de 20 à 250 px ;

Lorsque fieldType=stamp, la plage autorisée est de 30 à 280 px ;

Le sceau de recouvrement n'a pas besoin de ce paramètre.

 

 

 

width

int

false

Largeur du contrôle de signature, applicable lorsque fieldType est signature/stamp, exprimée en px. Seuls les entiers positifs sont acceptés. La valeur par défaut est auto (taille automatique par le système) ;

Lorsque fieldType=signature, la plage peut être définie entre 20 et 250 px ;

Lorsque fieldType=stamp, la plage peut être définie entre 30 et 280 px ;

Le cachet de jonction n'a pas besoin de spécifier ce paramètre.

 

 

 

signatureOptions

string

false

Options du widget de signature. S'applique uniquement lorsque fieldType est signature

Paramètres d'entrée possibles :

template : signature à partir d'un modèle

handDrawn : signature manuelle dessinée à la main

upload : téléchargement local d'une image de signature

aiHandDrawn : signature manuscrite par IA

Sélection multiple possible, séparée par des virgules ; sélection intégrale par défaut

 

 

 

movable

boolean

false

Autoriser le déplacement de la position lors de la signature, false par défaut

false - ne permet pas au signataire de modifier la position de son widget de signature

true - permet au signataire de modifier la position de son widget de signature

 

 

 

allowedOptions

array

false

Options autorisant l'approbation par le signataire, s'appliquent lorsque fieldType est approval. Valeur par défaut : ["approve", "decline"]

approve- Approuver

decline-Rejet

 

 

 

pageNo

string

false

Numéros de page de signature ; les pages consécutives sont reliées par « - », les pages individuelles par « , »

Exemple : 1-3,6-10

Lorsque pagingSealMode=assignedPages, transmettez la plage de numéros de page où le cachet de contre-seing est apposé. Le cachet de contre-seing ne peut être utilisé que pour des fichiers de plus d'une page.

 

 

 

posX

float

false

Coordonnée axiale x

[Remarque] Si fieldType est signature, la position des coordonnées indique la zone de signatureCoin inférieur gauche;

Si fieldType est stamp, la position des coordonnées indique la zone de cachetagePoint centralPosition

À partir du 3 février 2026, lorsque fieldType est signature ou stamp, la position des coordonnées indique le point central de la zone de cachetage.

Pour le cachet de contre-seing, vous pouvez transmettre 0, mais pas null ; le contrôle est fixé sur le bord droit du document.

 

 

 

posY

float

false

Coordonnée axiale y

[Remarque] Si fieldType est signature, la position des coordonnées indique la zone de signatureCoin inférieur gauche;

Si fieldType est stamp, la position des coordonnées indique la zone de cachet.Point centralPosition

À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées indique le point central de la zone de cachet.

 

 

fillConfigs

array

false

Remplir les informations du contrôle

 

 

 

fieldName

string

false

Nom du contrôle, limite de caractères : 128

 

 

 

required

boolean

false

Obligatoire ou non, obligatoire par défaut

true - Obligatoire

false - Non obligatoire

 

 

 

fieldType

string

false

Type de contrôle :

1 - Texte sur une seule ligne

15 - Case à cocher

 

 

 

textField

object

false

Propriétés du contrôle de texte

 

 

 

 

overflowType

int

false

S'applique uniquement au type text, valeur par défaut : 1

1 - Réduction automatique de la taille de police

2-Limiter l'entrée

 

 

 

 

minFontSize

float

false

S'applique uniquement au texte, s'applique uniquement lorsque overflowType=1, valeur par défaut 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

Largeur du contrôle, valeur par défaut 160px

 

 

 

 

font

int

false

S'applique uniquement au texte, police de caractères, valeur par défaut SimSun

1-SimSun

2-New SimSun

4-HeiTi

5-KaiTi

6-Arial

7-Helvetica

9-Times New Roman

10-FangSong

11-Georgia

12-Monospace

 

 

 

 

fontSize

float

false

S'applique uniquement au texte, taille de la police, valeur par défaut 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

S'applique uniquement au texte, couleur hexadécimale, valeur par défaut noir #000

 

 

 

 

bold

boolean

false

S'applique uniquement au texte, graisse de la police, valeur par défaut false

true-Graissé

false-Pas de graisse

 

 

 

 

italic

boolean

false

S'applique uniquement au texte, italique, valeur par défaut false

true-Italique

false-Pas d'italique

 

 

 

 

underline

boolean

false

S'applique uniquement au texte, indique si le soulignement doit être ajouté, par défaut false

true-Ajouter un soulignement

false-Pas de soulignement

 

 

 

 

lineThrough

boolean

false

S'applique uniquement au texte, indique si une strikethrough doit être ajoutée, par défaut false

true-Ajouter une strikethrough

false-Pas de strikethrough

 

 

 

 

horizontalAlignment

string

false

S'applique uniquement au texte, alignement horizontal centré, par défaut left

LEFT-Aligné à gauche

CENTER-Centré

RIGHT-Aligné à droite

 

 

 

tickBoxField

object

false

Propriétés de la case à cocher

 

 

 

 

tickOptions

array

false

S'applique uniquement à tickBox, par défaut 1

1-Coché

2-branches

 

 

 

posX

float

false

Coordonnée X de la position du contrôle

 

 

 

posY

float

false

Coordonnée Y de la position du contrôle

 

 

 

pageNo

string

false

Numéro de page où se trouve le contrôle

 

 

signDateConfigs

array

false

Informations sur la position de la date de signature

 

 

 

movable

boolean

false

Autoriser le déplacement de la position lors de la signature, par défaut false

false - Le signataire ne peut pas ajuster la position de son propre contrôle de signature

true - Le signataire peut ajuster la position de son propre contrôle de signature

 

 

 

pageNo

string

false

Numéros de pages de signature ; les pages consécutives sont reliées par « - », les pages individuelles sont séparées par « , », exemple : 1-3, 6-10 ;

Séparer avec « , » si non consécutif.

 

 

 

posX

float

false

Décalage selon l'axe x, l'origine des coordonnées est le coin inférieur gauche de la page

 

 

 

posY

float

false

Décalage selon l'axe y, l'origine des coordonnées est le coin inférieur gauche de la page

 

 

 

signDateFormat

string

false

Format de la date de signature, le format par défaut est yyyy-MM-dd

Formats spécifiés pris en charge :

yyyy an MM mois dd jour

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

Exemple de requête

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "CCInfos": [
      {
        "userEmail": "cc_user@esignglobal.com",
        "userName": "cc_user_name",
        "ccOrder": 1
      }
    ],
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "signTaskSuspend": true,
        "suspensionKey": "approval-node-001",
        "suspendReason": "等待外部审批",
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

 

Paramètres de réponse

Nom du paramètre

Type

Description

envelopeId

string

ID du pli

CCInfos

array

Ensemble d'informations sur les destinataires en copie

 

userEmail

string

Adresse e-mail du destinataire en copie

 

userName

string

Nom du destinataire en copie

signFiles

array

Ensemble d'informations sur les documents à signer

 

fileKey

string

fileKey du document à signer

attachments

array

Ensemble des pièces jointes du pli

 

fileKey

string

fileKey du fichier

signerInfos

array

Informations de signature

 

recipientId

string

ID du signataire

 

businessId

string

Numéro d'entreprise personnalisé par le développeur, longueur maximale de 500 caractères

 

userEmail

string

Adresse e-mail du signataire

 

userName

string

Nom du signataire

 signUrlstringURL du lien de signature

 

signOrder

int

Ordre de signature du signataire, minimum 1

 

accessCode

string

Mot de passe d'accès à la page de signature

Exemple de réponse

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}