Création rapide d'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 le flux de signature commence automatiquement.
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 caractères : 1000
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 la modification du nom par la partie signataire, applicable uniquement aux signatures sur 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 maximale 500), doit respecter le protocole https.
sendLaterAfterSeconds					long	false	Prise en charge du report d'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
	customizeSettings				object	false	Configuration personnalisée
		notificationSettings			object	false	Configuration personnalisée de type notification
			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 pris en charge
	documentFields				array	false	Liste des contrôles de dimensions de document. Utilisé pour ajouter des contrôles de dimensions de document non liés à un signataire sur un document spécifié.
	fieldType				string	false	Type de contrôle. Transmettez eMeterai pour indiquer le contrôle de taxe de timbre indonésien.
	pageNo				string	false	Numéro de page où se trouve le contrôle. Le contrôle de taxe de timbre 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 non continues tels que 1-3 ou 1,3 ne sont pas pris en charge.
	posX				float	false	Dé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.
	posY				float	false	Décalage selon l'axe y, 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.
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é de fichier fileKey
signerInfos					array	true	Ensemble des informations sur les signataires
	businessId				string	false	Numéro d'affaire 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 un e-mail de notification lorsque userEmail est fourni, envoie une notification SMS lorsque phoneNumber est fourni none- Aucune notification n'est envoyée 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, utilisé pour afficher le nom du signataire sur la page de signature et dans l'enveloppe externe. [Remarque] Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > \| ? ainsi que tous les emojis
	minimumReadingDuration				int	false	Définit le délai de lecture obligatoire sur la page de configuration, par défaut 0 (unité : secondes, maximum 999) 0 ou l'absence de valeur indique que la fonctionnalité est désactivée, sans compte à rebours de lecture
	readToEndRequired				boolean	false	Indique si la lecture jusqu'à la fin est obligatoire. Par défaut false ; true active la fonctionnalité, false ou l'absence de valeur la désactive.
	phoneNumber				object	false	Numéro de téléphone, vide par défaut Paramètre obligatoire lors de l'envoi d'une notification par SMS ; countryCode et number doivent tous deux être fournis
		countryCode			string	false	Code international du pays/région, le « + » n'est pas nécessaire
		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 des signataires, minimum 1. Les signatures désordonnées peuvent avoir la même valeur d'ordre.
	anySigner				boolean	false	Autorise-t-il toute personne à signer, par défaut false true- Pour un même signOrder, il suffit qu'une seule personne signe false- Pour un même signOrder, toutes les personnes 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, 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 du mot de passe d'accès, ne peut pas contenir le mot de passe d'accès, limite de longueur 30, requis lorsque authModes=accessCode
		sms			object	false	Vérification SMS OTP, requis lorsque authModes=sms
			countryCode		string	false	Code international du pays/région, sans inclure « + »
			number		string	false	Aucune validation de format, seule la longueur maximale de 13 caractères est limitée
		idVerification			object	false	Paramètres de vérification des pièces d'identité, requis lorsque authModes=idVerification
			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 par e-mail OTP, requis lorsque authModes=emailAuth
			authEmail		string	false	Adresse e-mail de vérification d'identité du signataire
		digitalId			array	false	Vérification d'identité électronique, requis lorsque authModes=digitalId
			authApp		string	false	Application utilisée pour la vérification d'identité électronique singpass- Utiliser Singpass pour l'authentification iamsmart-Utiliser i AM Smart pour l'authentification
			idNumber		string	false	Numéro de pièce d'identité du signataire en attente de vérification 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), servant de début de séquence ; 2. Suivi de 6 chiffres ; 3. Enfin, 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 le « + »
			number		string	false	Aucune validation de format, seule la longueur maximale de 13 caractères est limitée
	digitalSignature				boolean	false	Indique si la signature numérique est activée, par défaut false true-activé, false-désactivé
	freeFormSign				boolean	false	Indique si le signataire peut apposersa signature librement, valeur par défaut false Remarques complémentaires : Lorsque freeFormSign est défini sur true, les autres paramètres sous sealInfos ne sont pas nécessaires. Si ces paramètres sont transmis simultanément, freeFormSign a priorité sur sealInfos et les paramètres de sealInfos ne seront pas appliqués. [Attention]La signature libre permet à l'utilisateur de signer sans restriction quant au nombre et à la position des sceaux/signatures pouvant être glissés.
	sealInfos				array	false	Informations sur la tâche de signature
		fileKey			string	true	fileKey du document à signer
		signConfigs			array	false	Informations de position du contrôle : il est obligatoire de spécifier la position du contrôle pour procéder à 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, obligatoire par défaut true- Obligatoire false- Non obligatoire
			signFieldStyle		string	false	Mode d'application du sceau pour le contrôle de signature, normalSeal par défaut. normalSeal- Cachet ordinaire pagingSeal- Cachet de reliure Seuls les contrôles de signature et les contrôles de cachet prennent en charge la configuration du cachet de reliure.
			pagingSealMode		string	false	Plage de pages pour l'application du cachet de reliure, par défaut « all ». all- Toutes les pages assignedPages- Pages spécifiées 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- Appliquer le cachet selon les dimensions réelles de la signature/cachet targetSize- Définir manuellement la largeur et la hauteur de la zone de signature/cachet Lorsque sizeRule, height et width sont tous vides, appliquer le cachet selon les dimensions réelles de la signature/cachet ; Lorsque sizeRule est vide mais que height et width ne le sont pas, appliquer le cachet selon les dimensions spécifiées ; Lorsque sizeRule n'est pas vide, appliquer le cachet selon le mode d'affichage spécifié ; Le cachet de recouvrement n'a pas besoin de spécifier ce paramètre, il est appliqué uniquement en fonction des dimensions réelles.
			height		int	false	Hauteur du contrôle de signature, applicable lorsque fieldType est signature/stamp, unité en px, prend uniquement des entiers positifs, valeur par défaut auto (c'est-à-dire la taille automatique du système) ; Lorsque fieldType=signature, la plage réglable est de 20 à 250 px ; Lorsque fieldType=stamp, la plage réglable est de 30 à 280 px ; Le cachet de recouvrement n'a pas besoin de spécifier ce paramètre.
			width		int	false	Largeur du contrôle de signature, applicable lorsque fieldType est signature/stamp, unité en px, prend uniquement des entiers positifs, valeur par défaut auto (c'est-à-dire la taille automatique du système) ; Lorsque fieldType=signature, la plage réglable est de 20 à 250 px ; Lorsque fieldType=stamp, la plage réglable est de 30 à 280 px ; Le cachet de recouvrement n'a pas besoin de spécifier ce paramètre.
			signatureOptions		string	false	Options du contrôle de signature. Uniquement applicable lorsque fieldType est signature Paramètres d'entrée possibles : template : signature de modèle handDrawn : signature dessinée à la main upload : téléchargement local d'une image de signature Sélection multiple possible, séparée par ",", toutes sélectionnées par défaut
			movable		boolean	false	Autoriser le déplacement lors de la signature, par défaut false false - Le signataire ne peut pas ajuster la position de ses propres champs de signature true - Le signataire peut ajuster la position de ses propres champs de signature
			allowedOptions		array	false	Options autorisant l'approbation par le signataire, applicable lorsque fieldType est approval. Par défaut : ["approve", "decline"] approve- Accepter decline- Refuser
			pageNo		string	false	Numéros de page de signature ; les pages consécutives sont séparées par « - », et les pages individuelles par « , » Exemple : 1-3,6-10 À transmettre lorsque pagingSealMode=assignedPages, il s'agit de la plage de pages pour l'apposition du cachet de contrôle. Le cachet de contrôle ne peut être utilisé que sur des documents comportant plus d'une page.
			posX		float	false	Coordonnée en axe 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 cachetPoint 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 cachet. Le cachet de jointure peut être transmis avec la valeur 0, mais pas null ; le contrôle est fixé sur le bord droit du document.
			posY		float	false	Coordonnée de l'axe y 【Attention】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 cachetPoint 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 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	Champ obligatoire ou non, par défaut obligatoire 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 la saisie
				minFontSize	float	false	S'applique uniquement au type text et 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 type text, police, valeur par défaut SimSun (Songti) 1-Songti 2-Nouveau Songti 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 type text, taille de 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, noir par défaut #000
				bold	boolean	false	S'applique uniquement au texte, le texte est-il en gras, faux par défaut true-gras false-non gras
				italic	boolean	false	S'applique uniquement au texte, le texte est-il en italique, faux par défaut true-italique false-non italique
				underline	boolean	false	S'applique uniquement au texte, le texte est-il souligné, faux par défaut true-souligné false-non souligné
				lineThrough	boolean	false	S'applique uniquement au texte, le texte est-il barré, faux par défaut true-barré false-non barré
				horizontalAlignment	string	false	S'applique uniquement au texte, alignement horizontal centré, left par défaut 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, valeur par défaut 1 1-coché 2-croisé
			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 de position pour la date de signature
			movable		boolean	false	Autoriser le déplacement de la position lors de la signature, valeur par défaut false false-le signataire ne peut pas ajuster la position de ses propres contrôles de signature true-le signataire peut ajuster la position de ses propres contrôles de signature
			pageNo		string	false	Numéros de pages de signature ; les pages consécutives sont reliées par « - », les pages non consécutives par « , ». Exemple : 1-3, 6-10 ; Pour les pages non consécutives, utiliser « , » comme séparateur.
			posX		float	false	Décalage de l'axe des x, l'origine du système de coordonnées est le coin inférieur gauche de la page
			posY		float	false	Décalage de l'axe des y, l'origine du système de 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 pris en charge : jj mois MM année yyyy 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",
    "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,
        "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 pour copie
	userEmail	string	Adresse e-mail du destinataire pour copie
	userName	string	Nom du destinataire pour copie
signFiles		array	Ensemble d'informations sur les documents à signer
	fileKey	string	Clé de fichier du document signé
attachments		array	Ensemble des pièces jointes du pli
	fileKey	string	Clé de fichier du document
signerInfos		array	Informations de signature
	recipientId	string	ID du signataire
	businessId	string	Numéro d'affaires personnalisé par le développeur, limite de longueur 500
	userEmail	string	Adresse e-mail du signataire
	userName	string	Nom du signataire
	signUrl	string	URL 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"
}