Démarrer rapidement une enveloppe

POST /esignglobal/v1/envelope/createAndStart

Description de l'interface

Lancez rapidement une enveloppe, y compris la création de l'enveloppe, l'ajout de documents à signer et l'ajout de signataires, etc.

Prise en charge du démarrage automatique : Une fois l'appel d'interface réussi, l'enveloppe est créée et ouverte avec succès, et l'enveloppe commence automatiquement à circuler.
Prise en charge de la fin automatique : Une fois que toutes les parties signataires ont terminé la signature, 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 : « Offer Letter »
remark					string	false	Remarques sur l'enveloppe，Limite de longueur : 1 000 caractères
signerSettings					object	false	Opérations autorisées pour le signataire
	allowTransfer				boolean	false	Indique si le signataire est autorisé à transférer cette enveloppe à une autre personne pour signature, false par défaut true - Autorise le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ; false - N'autorise pas le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ;
	allowModifyName				boolean	false	Indique si le signataire est autorisé à modifier le nom, uniquement valable pour la signature de modèle, false par défaut true - Autorise le signataire à modifier le nom false - N'autorise pas le signataire à modifier le nom
expireAfterSeconds					long	false	Délai d'expiration de l'enveloppe, après combien de secondes 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 être une adresse de protocole https.
sendLaterAfterSeconds					long	false	Prise en charge de l'envoi différé par l'utilisateur, en secondes Plage de temps prise en charge : 3 600 secondes (1 heure) à 259 200 secondes (30 jours)
CCInfos					array	false	Ensemble d'informations sur les personnes en copie
	userEmail				string	false	Adresse e-mail de la personne 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 l'enveloppe. 【Attention】: Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > \| ？ ni aucune émoticône emoji
	customizeSettings				object	false	Configuration personnalisée
		notificationSettings			object	false	Configuration personnalisée de type notification
			notificationLanguage		string	false	Langue de notification, anglais par défaut en-US Anglais zh-CN Chinois simplifié zh-Hant Chinois traditionnel ja-JP Japonais ES-MX Espagnol
signFiles					array	true	Ensemble d'informations sur les documents à signer, l'ordre d'affichage est l'ordre d'ajout des fichiers.
	fileKey				string	true	Clé de fichier du document à signer (fileKey), seul le format PDF est pris en charge
attachments					array	false	Ensemble de pièces jointes à l'enveloppe, l'ordre d'affichage est l'ordre d'ajout des fichiers.
	fileKey				string	false	Clé de fichier (fileKey)
signerInfos					array	true	Ensemble d'informations sur le signataire
	businessId				string	false	Numéro d'entreprise personnalisé par le développeur, limite de longueur de 500
	deliveryMethods				string	false	Méthode de notification, par défaut auto auto- Envoyer une notification par e-mail lorsque userEmail est transmis, envoyer une notification par SMS lorsque phoneNumber est transmis none- Ne pas envoyer de notification de message email- Envoyer une notification par e-mail sms- Envoyer une notification par SMS WhatsApp- Envoyer une notification WhatsApp
	userEmail				string	true	Adresse e-mail du signataire
	userName				string	true	Nom du signataire, utilisé pour afficher le nom du signataire sur la page de signature et l'enveloppe. 【注】Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > \| ？ni aucune émoticône emoji
	phoneNumber				object	false	Numéro de téléphone, par défaut vide Paramètre obligatoire lorsque la notification par SMS est requise, countryCode et number doivent être transmis
		countryCode			string	false	Indicatif international du pays/de la région, pas besoin de transmettre « + »
		number			string	false	Aucune vérification de format, seule la longueur maximale de 13 chiffres est limitée
	customizeSettings				object	false	Configuration personnalisée
		notificationSettings			object	false	Configuration personnalisée de type notification
			customizeMessage		string	false	Notification de message exclusive, limite de 200 caractères
			notificationLanguage		string	false	Langue de la notification, anglais par défaut en-US Anglais zh-CN Chinois simplifié zh-Hant Chinois traditionnel ja Japonais ES-MX Espagnol
	signOrder				int	true	Ordre de signature des signataires, le minimum est 1. Une signature non ordonnée peut spécifier la même valeur d'ordre.
	anySigner				boolean	false	Indique si la signature d'une seule personne est prise en charge, false par défaut true-Une seule personne du même signOrder doit signer false-Toutes les personnes du même signOrder doivent signer
	authModes				string	false	Méthode de vérification, noAuth par défaut noAuth-Ne pas vérifier accessCode-Utiliser le mot de passe de signature pour vérifier sms- Vérification OTP par SMS idVerification- Vérification de la pièce d'identité emailAuth- Vérification OTP par e-mail digitalId- Authentification d'identité électronique
	authConfig				object	false	Paramètres de la méthode de vérification
		accessCode			object	false	Paramètres du mot de passe de signature, lorsque authModes=accessCodeest obligatoire
			accessCode		string	false	Contenu du mot de passe, insensible à la casse, peut contenir des lettres et des chiffres, longueur limitée à 45
			promptInfo		string	false	Informations d'invite du mot de passe d'accès, ne peuvent pas contenir le mot de passe d'accès, longueur limitée à 30, obligatoire lorsque authModes=1.
		sms			object	false	Vérification OTP par SMS, lorsque authModes=smsest obligatoire
			countryCode		string	false	Indicatif international du pays/de la région, pas besoin de transmettre le signe "+"
			number		string	false	Aucune vérification de format n'est effectuée, seule la longueur maximale est limitée à 13 chiffres
		idVerification			object	false	Paramètres de vérification de la pièce d'identité, lorsque authModes=idVerificationest 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, lorsque authModes=emailAuthest obligatoire
			authEmail		string	false	Adresse e-mail de vérification de l'identité du signataire
		digitalId			array	false	Authentification d'identité électronique, obligatoire lorsque authModes=digitalId
			authApp		string	false	Application utilisée pour l'authentification d'identité électronique singpass - Utiliser Singpass pour l'authentification
			idNumber		string	false	Numéro de pièce d'identité du signataire à vérifier
	digitalSignature				boolean	false	Indique si la signature numérique est activée, false par défaut true - Activé, false - Désactivé
	freeFormSign				boolean	false	Indique si le signataire peut apposer un sceau librement, valeur par défaut false Remarques supplémentaires : Lorsque freeFormSign est défini sur true, il n'est pas nécessaire de transmettre d'autres paramètres sous sealInfos. Si les deux sont transmis, freeFormSign a la priorité sur sealInfos et les paramètres sous sealInfos ne prendront pas effet. 【Attention】La signature libre ne limite pas le nombre et la position des tampons/signatures que le signataire peut faire glisser.
	sealInfos				array	false	Informations sur la tâche de signature
		fileKey			string	true	Signer le fichier fileKey
		signConfigs			array	false	Informations sur l'emplacement du contrôle. Vous devez spécifier les informations d'emplacement du contrôle pour pouvoir effectuer une signature électronique.
			fieldType		string	false	Type de contrôle, par défaut signature signature- Contrôle de signature stamp- Contrôle de tampon approval- Contrôle d'approbation
			sizeRule		string	false	Méthode d'affichage de la taille de la zone de signature originalSize- Appliquer le tampon en fonction de la taille réelle de la signature/du tampon targetSize- Largeur et hauteur personnalisées de la zone de signature/tampon Lorsque sizeRule, height et width sont tous vides, le tampon est appliqué en fonction de la taille réelle de la signature/du tampon ; Lorsque sizeRule est vide et que height et width ne sont pas vides, le tampon est appliqué en fonction de la taille spécifiée ; Lorsque sizeRule n'est pas vide, le tampon est appliqué selon la méthode d'affichage spécifiée.
			height		int	false	Hauteur du contrôle de signature, applicable lorsque fieldType est signature/stamp, en px, prend uniquement en charge les entiers positifs, par défaut auto (c'est-à-dire la taille automatique du système) ; Lorsque fieldType=signature, la plage de valeurs peut être définie entre 20 et 250 px ; Lorsque fieldType=stamp, la plage peut être définie entre 30 et 280px ;
			width		int	false	Largeur du contrôle de signature, applicable lorsque fieldType est signature/stamp, en px, prend uniquement en charge les entiers positifs, auto par défaut (c'est-à-dire la taille automatique du système) ; Lorsque fieldType=signature, la plage peut être définie entre 20 et 250px ; Lorsque fieldType=stamp, la plage peut être définie entre 30 et 280px ;
			signatureOptions		string	false	Options du contrôle de signature. S'applique uniquement lorsque fieldType est signature Paramètres d'entrée possibles : template : signature de modèle handDrawn : signature dessinée à la main upload : télécharger une image de signature locale Plusieurs options peuvent être sélectionnées, séparées par « , », toutes les options sont sélectionnées par défaut
			movable		boolean	false	Autoriser le déplacement de la position lors de la signature, false par défaut false - N'autorise pas le signataire à ajuster la position de son propre contrôle de signature true - Autorise le signataire à ajuster la position de son propre contrôle de signature
			allowedOptions		array	false	Options d'approbation autorisées pour le signataire, applicables lorsque fieldType est approval. La valeur par défaut est ["approve", "decline"] approve-Accepter decline- Refuser
			pageNo		string	false	Signer les numéros de page ; connecter les numéros de page consécutifs avec « - », connecter les numéros de page individuels avec « , » Exemple : 1-3,6-10
			posX		float	false	Coordonnée de l’axe x 【Attention】Si fieldType est signature, la position des coordonnées fait référence à la zone de signatureCoin inférieur gauche； Si fieldType est stamp, la position des coordonnées fait référence à la zone de cachetPoint centralPosition À partir du 3 février 2026, si fieldType est signature ou stamp, la position des coordonnées fait référence à la position du point central de la zone de cachet.
			posY		float	false	Coordonnée de l’axe y 【Attention】Si fieldType est signature, la position des coordonnées fait référence à la zone de signatureCoin inférieur gauche； Si fieldType est stamp, la position des coordonnées fait référence à la zone de cachetPoint centralPosition À partir du 3 février 2026, pour fieldType signature ou stamp, la position des coordonnées fait référence à la position du 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 128 caractères
			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 à text, 1 par défaut 1-Réduire automatiquement la taille de la police 2-Limiter la saisie
				minFontSize	float	false	S'applique uniquement à text, uniquement à overflowType=1, 8 par défaut 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, 160px par défaut
				font	int	false	S'applique uniquement au texte, police, 宋体 par défaut 1-宋体 2-新宋体 4-黑体 5-楷体 6-Arial 7-Helvetica 9-Times New Roman 10-仿宋 11-Georgia 12-Monospace
				fontSize	float	false	S'applique uniquement au texte, taille de la police, 12 par défaut 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, si la police est en gras, false par défaut true-Gras false-Non gras
				italic	boolean	false	S'applique uniquement au texte, si italique, false par défaut true-Italique false-Non italique
				underline	boolean	false	S'applique uniquement au texte, indique si la police doit être soulignée, false par défaut true - Ajouter un soulignement false - Ne pas ajouter de soulignement
				lineThrough	boolean	false	S'applique uniquement au texte, indique si une barre de suppression doit être ajoutée, false par défaut true - Ajouter une barre de suppression false - Ne pas ajouter de barre de suppression
				horizontalAlignment	string	false	S'applique uniquement au texte, format d'alignement horizontal, 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, 1 par défaut 1 - Coche 2 - Croix
			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, false par défaut false - N'autorise pas le signataire à ajuster la position de son propre contrôle de signature true - Autorise le signataire à ajuster la position de son propre contrôle de signature
			pageNo		string	false	Numéro de page de signature ; les numéros de page consécutifs sont reliés par "-", les numéros de page individuels sont reliés par ","，Exemple : 1-3, 6-10 ; Si non consécutifs, entrez "," pour séparer.
			posX		float	false	Décalage de l'axe des x, le coin inférieur gauche de la page est l'origine des coordonnées
			posY		float	false	Décalage de l'axe des y, le coin inférieur gauche de la page est l'origine des coordonnées
			signDateFormat		string	false	Format de la date de signature, le format par défaut est aaaa-MM-jj Formats pris en charge : aaaa年MM月jj日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM 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 de l'enveloppe
CCInfos		array	Collection 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	Collection d'informations sur les documents signés
	fileKey	string	fileKey du document signé
attachments		array	Collection de pièces jointes de l'enveloppe
	fileKey	string	fileKey du fichier
signerInfos		array	Informations de signature
	businessId	string	Numéro d'entreprise personnalisé du développeur, limite de longueur de 500
	userEmail	string	Adresse e-mail du signataire
	userName	string	Nom du signataire
	signUrl	string	Adresse du lien de signature
	signOrder	int	Ordre de signature du signataire, le minimum est 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"
}