Mabilis na Magpasimula ng Sobre

POST /esignglobal/v1/envelope/createAndStart

Paglalarawan ng Interface

Mabilis na magsimula ng sobre, kabilang ang paglikha ng sobre, pagdaragdag ng mga dokumentong pipirmahan, pagdaragdag ng mga lumalagda, atbp.

Suportado ang awtomatikong pagbubukas：Matapos ang matagumpay na pagtawag sa interface, matagumpay na malilikha at mabubuksan ang sobre, at awtomatikong magsisimula ang sirkulasyon ng sobre.
Suportado ang awtomatikong pagtatapos：Awtomatikong magtatapos ang sobre pagkatapos makumpleto ng lahat ng lumalagda ang pagpirma.

Mga Parameter ng Kahilingan

Pangalan ng Parameter					Uri	Kinakailangan	Paliwanag
subject					string	true	Paksa ng Sobre Halimbawa: “Offer Letter”
remark					string	false	Mga Tala sa Sobre，Limitasyon sa haba na 1000 salita
signerSettings					object	false	Mga operasyon na pinapayagan para sa lumagda
	allowTransfer				boolean	false	Kung pinapayagan ang lumagda na ilipat ang sobre sa ibang tao para lumagda, default ay false true-Pinapayagan ang lumagda sa sobre na magkaroon ng kapangyarihang ilipat ang sobre sa ibang tao; false-Hindi pinapayagan ang lumagda sa sobre na magkaroon ng kapangyarihang ilipat ang sobre sa ibang tao;
	allowModifyName				boolean	false	Kung pinapayagan ang lumagda na baguhin ang pangalan, para lamang sa pirma ng template, default ay false true-Pinapayagan ang lumagda na baguhin ang pangalan false-Hindi pinapayagan ang lumagda na baguhin ang pangalan
expireAfterSeconds					long	false	Oras ng pag-expire ng sobre, pagkatapos ng ilang segundo, mag-e-expire ang sobre Saklaw ng pag-expire: 86,400 segundo (1 araw) ~ 7,776,000 segundo (90 araw)
redirectUrl					string	false	Kailangang maging isang valid na https address
callBackUrl					string	false	Callback address (haba 500), kailangang sumunod sa https protocol address.
sendLaterAfterSeconds					long	false	Suporta para sa pagpapaliban ng pagpapadala ng user, sa segundo Saklaw ng suportadong oras: 3600 segundo (1 oras) ~ 259200 segundo (30 araw)
CCInfos					array	false	Koleksyon ng impormasyon ng mga kinokopyahan
	userEmail				string	false	Email address ng kinokopyahan
	userName				string	false	Pangalan ng CC, ginagamit para ipakita sa labas ang pangalan ng CC sa pahina ng pagpirma at sobre. 【Pansin】：Hindi maaaring maglaman ng sumusunod na 9 na espesyal na karakter: / \ : * " < > \| ？at lahat ng emoji
	customizeSettings				object	false	Custom na konfigurasyon
		notificationSettings			object	false	Custom na konfigurasyon ng uri ng notipikasyon
			notificationLanguage		string	false	Wika ng notipikasyon, default ay Ingles en-US Ingles zh-CN Pinasimpleng Tsino zh-Hant Tradisyunal na Tsino ja-JP Hapon ES-MX Espanyol
signFiles					array	true	Koleksyon ng impormasyon ng dokumento sa pagpirma, ang pagkakasunod-sunod ng pagpapakita ay ang pagkakasunod-sunod ng pagdagdag ng dokumento.
	fileKey				string	true	fileKey ng dokumento sa pagpirma, PDF format lamang ang suportado
attachments					array	false	Koleksyon ng mga attachment sa sobre, ang pagkakasunod-sunod ng pagpapakita ay ang pagkakasunod-sunod ng pagdagdag ng dokumento.
	fileKey				string	false	fileKey ng dokumento
signerInfos					array	true	Koleksyon ng impormasyon ng lumagda
	businessId				string	false	Custom na business number ng developer, limitadong haba na 500
	deliveryMethods				string	false	Paraan ng notipikasyon, default ay auto auto-Magpadala ng email notification kapag ipinasok ang userEmail, magpadala ng SMS notification kapag ipinasok ang phoneNumber none-Huwag magpadala ng mensahe ng notipikasyon email-Magpadala ng email notification sms-Magpadala ng SMS notification WhatsApp-Magpadala ng WhatsApp notification
	userEmail				string	true	Email address ng lumagda
	userName				string	true	Pangalan ng lumagda, ginagamit para ipakita ang pangalan ng lumagda sa pahina ng paglagda at sobre. 【Tandaan】Hindi maaaring maglaman ng sumusunod na 9 na espesyal na karakter: / \ : * " < > \| ？at lahat ng emoji
	phoneNumber				object	false	Numero ng telepono, default ay blangko Kinakailangang parameter kapag kailangan ang SMS notification, kailangang ipasok ang countryCode at number
		countryCode			string	false	International code ng bansa/rehiyon, hindi kailangang ipasok ang “+”
		number			string	false	Walang format na pag-verify, nililimitahan lamang ang maximum na haba sa 13 digits
	customizeSettings				object	false	Custom na konfigurasyon
		notificationSettings			object	false	Pasadya na konfigurasyon ng uri ng notipikasyon
			customizeMessage		string	false	Eksklusibong notipikasyon ng mensahe, limitasyon sa karakter na 200
			notificationLanguage		string	false	Wika ng notipikasyon, Ingles bilang default en-US Ingles zh-CN Pinasimpleng Tsino zh-Hant Tradisyunal na Tsino ja Hapon ES-MX Espanyol
	signOrder				int	true	Pagkakasunud-sunod ng pagpirma ng lumagda, ang pinakamababa ay 1. Maaaring tukuyin ang parehong halaga ng pagkakasunud-sunod para sa walang-ayos na pagpirma.
	anySigner				boolean	false	Sinusuportahan ba ang pagpirma ng kahit sinong isa, default ay false true-Kailangan lamang ng isang tao na pumirma sa parehong signOrder false-Kailangang pumirma ang lahat sa parehong signOrder
	authModes				string	false	Paraan ng pagpapatunay, default ay noAuth noAuth-Huwag patotohanan accessCode-Gumamit ng password sa pagpirma upang patotohanan sms- Pagpapatunay ng SMS OTP idVerification- Pagpapatunay ng ID ng Pagkakakilanlan emailAuth- Pagpapatunay ng Email OTP digitalId- Pagpapatunay ng Elektronikong Pagkakakilanlan
	authConfig				object	false	Mga Setting ng Paraan ng Pagpapatunay
		accessCode			object	false	Mga setting ng password sa pagpirma, kapag ang authModes=accessCodeay kinakailangan
			accessCode		string	false	Nilalaman ng password, hindi sensitibo sa kaso, maaaring maglaman ng mga alphanumeric na character, limitasyon sa haba na 45
			promptInfo		string	false	Impormasyon ng prompt ng password sa pag-access, hindi maaaring maglaman ng password sa pag-access, limitasyon sa haba na 30, kinakailangan kapag ang authModes=1.
		sms			object	false	Pag-verify ng SMS OTP, kapag ang authModes=smsay kinakailangan
			countryCode		string	false	Internasyonal na code ng bansa/rehiyon, hindi na kailangang ipasok ang “+”
			number		string	false	Walang pag-verify ng format, ang limitasyon lamang ay ang maximum na haba ay 13 digit
		idVerification			object	false	Mga setting ng pagpapatunay ng ID ng pagkakakilanlan, kapag ang authModes=idVerificationay kinakailangan
			name		string	false	Buong pangalan sa ID ng lumagda, maximum na haba na 100 karakter
		emailAuth			object	false	Pagpapatunay ng OTP sa email, kinakailangan kapag ang authModes=emailAuth
			authEmail		string	false	Email address para sa pagpapatunay ng pagkakakilanlan ng lumagda
		digitalId			array	false	Pagpapatunay ng elektronikong pagkakakilanlan, kinakailangan kapag ang authModes=digitalId
			authApp		string	false	APP na ginagamit para sa pagpapatunay ng elektronikong pagkakakilanlan singpass-Gamitin ang Singpass para sa pagpapatunay ng pagkakakilanlan
			idNumber		string	false	Numero ng ID ng lumagda na kailangang patunayan
	digitalSignature				boolean	false	Kung bubuksan ang digital signature, default ay false true-bukas, false-hindi bukas
	freeFormSign				boolean	false	Kung ang lumagda ay malayang makakapirma, default na halaga ay false Karagdagang paliwanag: Kapag pinili ang freeFormSign bilang true, hindi na kailangang ipasa ang iba pang mga parameter sa ilalim ng sealInfos. Kung ipapasa nang sabay, mas mataas ang prayoridad ng freeFormSign kaysa sa sealInfos, at hindi magkakabisa ang mga parameter sa ilalim ng sealInfos 【Pansin】Ang malayang pagpirma ay hindi naglilimita sa bilang at posisyon ng mga selyo/pirma na maaaring i-drag ng lumagda
	sealInfos				array	false	Impormasyon sa Pagpirma ng Gawain
		fileKey			string	true	Pirmahan ang fileKey ng dokumento
		signConfigs			array	false	Impormasyon sa lokasyon ng kontrol, dapat tukuyin ang impormasyon sa lokasyon ng kontrol upang maisagawa ang elektronikong lagda.
			fieldType		string	false	Uri ng kontrol, ang default ay signature signature-Kontrol ng lagda stamp-Kontrol ng selyo approval-Kontrol ng pag-apruba
			sizeRule		string	false	Paraan ng pagpapakita ng laki ng lugar ng pagpirma originalSize-Batay sa aktwal na laki ng lagda/selyo targetSize-Pasadyang taas at lapad ng lugar ng lagda/selyo Kapag ang sizeRule, height, at width ay lahat walang laman, ang selyo ay ilalagay batay sa aktwal na laki ng lagda/selyo; Kapag ang sizeRule ay walang laman, at ang height at width ay hindi walang laman, ang selyo ay ilalagay batay sa tinukoy na laki; Kapag ang sizeRule ay hindi walang laman, ang selyo ay ilalagay batay sa tinukoy na paraan ng pagpapakita.
			height		int	false	Taas ng kontrol ng pagpirma, naaangkop sa fieldType na signature/stamp, ang unit ay px, sinusuportahan lamang ang pagpasa ng positibong integer, ang default ay auto (ibig sabihin, awtomatikong laki ng system); Kapag ang fieldType=signature, ang saklaw na maaaring itakda ay 20-250px; Kapag ang fieldType=stamp, ang saklaw na maaaring itakda ay 30-280px;
			width		int	false	Lapad ng control ng pagpirma, naaangkop para sa fieldType na signature/stamp, unit ay px, sumusuporta lamang sa pagpasa ng positibong integer, default ay auto (ibig sabihin, awtomatikong laki ng system); Kapag ang fieldType=signature, ang saklaw na maaaring itakda ay 20-250px; Kapag ang fieldType=stamp, ang saklaw na maaaring itakda ay 30-280px;
			signatureOptions		string	false	Mga opsyon sa control ng lagda. Naaangkop lamang para sa fieldType na signature Maaaring ipasok na parameter: template: Lagda ng template handDrawn: Iginuhit na lagda upload: Lokal na pag-upload ng larawan ng lagda Maaaring pumili ng marami, paghiwalayin gamit ang ",", default ay piliin lahat
			movable		boolean	false	Payagan ang paglipat ng posisyon kapag pumirma, default ay false false-hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanyang control ng pagpirma true-pinapayagan ang lumagda na ayusin ang posisyon ng kanyang control ng pagpirma
			allowedOptions		array	false	Mga opsyon na pinapayagan para sa pag-apruba ng lumagda, naaangkop para sa fieldType na approval. Default ay ["approve", "decline"] approve-Sumasang-ayon decline- Tanggihan
			pageNo		string	false	Mga pahina na lalagdaan; ikonekta ang magkakasunod na pahina gamit ang "-", ikonekta ang mga hiwa-hiwalay na pahina gamit ang "," Halimbawa: 1-3,6-10
			posX		float	false	X-axis coordinate 【Pansin】Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng lagdaKaliwang ibaba； Kung ang fieldType ay stamp, ang posisyon ng coordinate ay tumutukoy sa lugar ng pagtatakGitnang puntoPosisyon Simula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang posisyon ng coordinate ay tumutukoy sa gitnang punto ng lugar ng pagtatak.
			posY		float	false	Y-axis coordinate 【Pansin】Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng lagdaKaliwang ibaba； Kung ang fieldType ay stamp, ang posisyon ng coordinate ay tumutukoy sa lugar ng pagtatakGitnang puntoPosisyon Simula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang mga coordinate na posisyon ay tumutukoy sa sentrong punto ng lugar ng pagtatak.
		fillConfigs			array	false	Punan ang impormasyon ng control
			fieldName		string	false	Pangalan ng control, limitasyon ng bilang ng character ay 128
			required		boolean	false	Kung kinakailangan, default ay kinakailangan true-Kinakailangan false-Hindi kinakailangan
			fieldType		string	false	Uri ng control: 1-Isang linya ng teksto 15-Checkbox
			textField		object	false	Mga katangian ng control ng teksto
				overflowType	int	false	Para lamang sa text, default ay 1 1-Awtomatikong paliitin ang laki ng font 2-Limitahan ang pagpasok
				minFontSize	float	false	Para lamang sa text, para lamang sa overflowType=1, default ay 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	Lapad ng control, default na 160px
				font	int	false	Para lamang sa text, font, default na 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	Para lamang sa text, laki ng font, default na 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	Para lamang sa text, hexadecimal na kulay, default na itim #000
				bold	boolean	false	Para lamang sa text, kung naka-bold ang font, default na false true-Naka-bold false-Hindi naka-bold
				italic	boolean	false	Para lamang sa text, kung naka-italic, default na false true-Naka-italic false-Hindi naka-italic
				underline	boolean	false	Para sa text lang ito, kung idadagdag ang salungguhit sa font, default ay false true-Magdagdag ng salungguhit false-Huwag magdagdag ng salungguhit
				lineThrough	boolean	false	Para sa text lang ito, kung idadagdag ang strikeout, default ay false true-Magdagdag ng strikeout false-Huwag magdagdag ng strikeout
				horizontalAlignment	string	false	Para sa text lang ito, format na pahalang na nakasentro, default ay left LEFT-Nasa kaliwa CENTER-Nasa gitna RIGHT-Nasa kanan
			tickBoxField		object	false	Mga katangian ng checkbox
				tickOptions	array	false	Para sa tickBox lang ito, default ay 1 1-Tsek 2-Ekis
			posX		float	false	Posisyon ng control sa X coordinate
			posY		float	false	Posisyon ng kontrol sa Y coordinate
			pageNo		string	false	Pahina kung saan naroroon ang kontrol
		signDateConfigs			array	false	Impormasyon sa posisyon ng petsa ng pagpirma
			movable		boolean	false	Payagan ang paglipat ng posisyon sa panahon ng pagpirma, default ay false false - hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanyang sariling kontrol sa pagpirma true - pinapayagan ang lumagda na ayusin ang posisyon ng kanyang sariling kontrol sa pagpirma
			pageNo		string	false	Pahina ng pagpirma; ang magkakasunod na pahina ay konektado gamit ang "-", ang mga indibidwal na pahina ay konektado gamit ang ","，Halimbawa: 1-3, 6-10; Kung hindi magkakasunod, ipasa ang "," upang paghiwalayin.
			posX		float	false	X-axis offset, ang lower left corner ng pahina ay ang pinagmulan ng coordinate
			posY		float	false	Y-axis offset, ang lower left corner ng pahina ay ang pinagmulan ng coordinate
			signDateFormat		string	false	Format ng petsa ng pagpirma, ang default na format ay yyyy-MM-dd Sinusuportahan ang tinukoy na format: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

Halimbawa ng kahilingan

{
    "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"
              }
            ]
        }
      ]
    }
  ]
}

Mga Parameter ng Tugon

Pangalan ng Parameter		Uri	Paglalarawan
envelopeId		string	ID ng Sobre
CCInfos		array	Koleksyon ng Impormasyon ng CC
	userEmail	string	Email Address ng CC
	userName	string	Pangalan ng CC
signFiles		array	Koleksyon ng Impormasyon ng Nilagdaang Dokumento
	fileKey	string	fileKey ng Nilagdaang Dokumento
attachments		array	Koleksyon ng Attachment ng Sobre
	fileKey	string	fileKey ng File
signerInfos		array	Impormasyon sa Paglagda
	businessId	string	Custom na numero ng negosyo ng developer, limitasyon sa haba na 500
	userEmail	string	Email Address ng Lumalagda
	userName	string	Pangalan ng lumagda
	signUrl	string	Link ng lagda
	signOrder	int	Pagkakasunod-sunod ng paglagda, ang pinakamababa ay 1
	accessCode	string	Password para sa pahina ng paglagda

Halimbawa ng tugon

{
  "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"
}