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 sa oras na ito ay awtomatikong magsisimula ang pagdaloy 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	Paglalarawan
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 ipasa ang sobre sa ibang tao para lumagda, default ay false true-Pinapayagan ang lumagda sa sobre na magkaroon ng kapangyarihang ipasa ang sobre sa iba; false-Hindi pinapayagan ang lumagda sa sobre na magkaroon ng kapangyarihang ipasa ang sobre sa iba;
	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	Expiration time ng sobre, pagkatapos ng ilang segundo ay mage-expire ang sobre Saklaw ng expiration: 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	Sinusuportahan ang pagpapaliban ng pagpapadala ng user, sa segundo Saklaw ng oras na sinusuportahan: 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 dapat maglaman ng sumusunod na 9 na espesyal na karakter：/ \ : * " < > \| ？at lahat ng emoji
	customizeSettings				object	false	Custom na configuration
		notificationSettings			object	false	Custom na configuration para sa mga notification
			notificationLanguage		string	false	Wika ng notification, default na kinukuha ang configuration ng “Default na wika ng notification” en-US Ingles zh-CN Pinasimpleng Tsino zh-Hant Tradisyunal na Tsino ja-JP Hapon es-MX Espanyol pt-PT Portuges th-TH Thai id-ID Indonesian vi-VN Vietnamese ms-MY Malay fil-PH Filipino de-DE Aleman fr-FR Pranses ru-RU Ruso it-IT Italyano ko-KR Koreano
signFiles					array	true	Koleksyon ng impormasyon ng nilagdaang dokumento, ang pagkakasunud-sunod ng pagpapakita ay ang pagkakasunud-sunod ng pagdaragdag ng dokumento.
	fileKey				string	true	fileKey ng nilagdaang dokumento, PDF format lamang ang suportado
attachments					array	false	Koleksyon ng mga attachment ng sobre, ang pagkakasunud-sunod ng pagpapakita ay ang pagkakasunud-sunod ng pagdaragdag ng dokumento.
	fileKey				string	false	fileKey ng dokumento
signerInfos					array	true	Koleksyon ng impormasyon ng lumagda
	businessId				string	false	Custom na numero ng negosyo ng developer, limitasyon sa haba na 500
	deliveryMethods				string	false	Paraan ng abiso, ang default ay auto auto-Magpadala ng abiso sa email kapag ipinasok ang userEmail, magpadala ng abiso sa SMS kapag ipinasok ang phoneNumber none-Huwag magpadala ng abiso sa mensahe email- Magpadala ng email na abiso sms- Magpadala ng SMS na abiso WhatsApp- Magpadala ng WhatsApp na abiso
	userEmail				string	false	Email address ng lumagda
	userName				string	true	Pangalan ng lumagda, ginagamit para ipakita ang pangalan ng lumagda sa pahina ng paglagda at sa 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 Kapag kailangan ang SMS na abiso, kailangang ipasa ang parameter na ito, kailangang ipasa ang countryCode at number
		countryCode			string	false	International code ng bansa/rehiyon, hindi kailangang ipasa ang “+”
		number			string	false	Walang format na pagpapatunay, nililimitahan lamang ang haba sa maximum na 13 digits
	customizeSettings				object	false	Custom na configuration
		notificationSettings			object	false	Custom na configuration para sa mga abiso
			customizeMessage		string	false	Eksklusibong abiso ng mensahe, limitasyon sa karakter na 200
			notificationLanguage		string	false	Wika ng abiso, default ay ang configuration ng “Default na wika ng abiso” en-US Ingles zh-CN Pinasimpleng Tsino zh-Hant Tradisyunal na Tsino ja-JP Hapon es-MX Espanyol pt-PT Portuges th-TH Thai id-ID Indonesian vi-VN Vietnamese ms-MY Malay fil-PH Filipino de-DE Aleman fr-FR Pranses ru-RU Ruso it-IT Italyano ko-KR Koreano
	signOrder				int	true	Ang pagkakasunud-sunod ng pagpirma ng mga lumagda, ang pinakamababa ay 1. Maaaring tukuyin ang parehong halaga ng pagkakasunud-sunod para sa walang-ayos na pagpirma.
	anySigner				boolean	false	Kung sinusuportahan ang pagpirma ng kahit sinong isa, default ay false true-Kailangan lamang pirmahan ng isa sa parehong signOrder false-Kailangang pirmahan ng lahat sa parehong signOrder
	authModes				string	false	Paraan ng pagpapatunay, ang default ay noAuth noAuth-Huwag patunayan accessCode-Gumamit ng password sa pagpirma para sa pagpapatunay sms-SMS OTP na pagpapatunay idVerification-Pagpapatunay ng ID emailAuth-Email OTP na pagpapatunay digitalId-Pagpapatunay ng elektronikong pagkakakilanlan whatsappAuth-WhatsApp OTP na pagpapatunay
	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 case-sensitive, maaaring maglaman ng mga letra at numero, limitasyon sa haba na 45
			promptInfo		string	false	Impormasyon sa prompt ng access password, hindi maaaring maglaman ng access password, limitasyon sa haba na 30, kapag ang authModes=accessCodeay kinakailangan.
		sms			object	false	Pagpapatunay ng SMS OTP, kapag ang authModes=smsay kinakailangan
			countryCode		string	false	International code ng bansa/rehiyon, hindi na kailangang ipasa ang “+”
			number		string	false	Hindi nagsasagawa ng pagpapatunay ng format, nililimitahan lamang ang maximum na haba sa 13 digit
		idVerification			object	false	Mga setting ng pagpapatunay ng ID, kapag ang authModes=idVerificationay kinakailangan
			name		string	false	Buong pangalan sa ID ng lumagda, maximum na haba na 100 character
		emailAuth			object	false	Pagpapatunay ng Email OTP, kapag ang authModes=emailAuthay kinakailangan
			authEmail		string	false	Email address ng pagpapatunay ng pagkakakilanlan ng lumagda
		digitalId			array	false	Pagpapatunay ng elektronikong pagkakakilanlan, kinakailangan kapag ang authModes=digitalId
			authApp		string	false	APP na ginamit para sa pagpapatunay ng elektronikong pagkakakilanlan singpass-Gumamit ng Singpass para sa pagpapatunay ng pagkakakilanlan iamsmart-Gumamit ng i AM Smart para sa pagpapatunay ng pagkakakilanlan
			idNumber		string	false	Numero ng ID ng lumagda na naghihintay ng pagpapatunay Kapag authApp=singpass , ang panuntunan sa pagpasa ay: malaking titik + 7 o 8 digit na numero + malaking titik Kapag authApp=iamsmart , ang panuntunan sa pagpasa ay: 1. Isang malaking titik (A-Z), o dalawang malaking titik (AA-ZZ), bilang simula ng pagkakasunod-sunod; 2. Pagkatapos ay 6 na digit na numero; 3. Sa huli ay isang check code, na maaaring numero (0-9) o letra (A-Z). Halimbawa: A888888(A)
		whatsappAuth			object	false	WhatsApp OTP verification, kinakailangan kapag authModes=whatsappAuth
			countryCode		string	false	International code ng bansa/rehiyon, hindi na kailangang ipasa ang “+”
			number		string	false	Hindi nagsasagawa ng pagpapatunay ng format, nililimitahan lamang ang maximum na haba sa 13 digit
	digitalSignature				boolean	false	Kung bubuksan ang digital signature, default ay false true-bukas, false-hindi bukas
	freeFormSign				boolean	false	Kung ang lumagda ay malayang pumirma, ang default 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, ang freeFormSign ay may mas mataas na prayoridad kaysa sa sealInfos, at ang mga parameter sa ilalim ng sealInfos ay hindi magkakabisa 【Pansin】Ang malayang pagpirma ay hindi naglilimita sa bilang at posisyon ng mga selyo/pirma na maaaring ilagay ng lumagda
	sealInfos				array	false	Impormasyon ng gawain sa pagpirma
		fileKey			string	true	FileKey ng dokumento sa pagpirma
		signConfigs			array	false	Impormasyon sa lokasyon ng control, dapat tukuyin ang impormasyon sa lokasyon ng control upang maisagawa ang elektronikong pagpirma.
			fieldType		string	false	Uri ng control, ang default ay signature signature-Control sa pagpirma stamp-Control sa selyo approval-Control sa pag-apruba
			sizeRule		string	false	Paraan ng pagpapakita ng laki ng lugar ng pagpirma originalSize-Maglagay ng selyo ayon sa aktwal na laki ng pirma/selyo targetSize-Pasadyang lapad at taas ng lugar ng pirma/selyo Kapag ang sizeRule, height, at width ay walang laman, ilagay ang selyo ayon sa aktwal na sukat ng lagda/selyo; Kapag ang sizeRule ay walang laman, at ang height at width ay hindi walang laman, ilagay ang selyo ayon sa tinukoy na sukat; Kapag ang sizeRule ay hindi walang laman, ilagay ang selyo ayon sa tinukoy na paraan ng pagpapakita.
			height		int	false	Taas ng control ng paglagda, naaangkop sa fieldType na signature/stamp, ang unit ay px, sinusuportahan lamang ang pagpasa ng positibong integer, default ay auto (ibig sabihin, awtomatikong sukat 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 paglagda, naaangkop sa fieldType na signature/stamp, ang unit ay px, sinusuportahan lamang ang pagpasa ng positibong integer, default ay auto (ibig sabihin, awtomatikong sukat 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 sa fieldType na signature Mga maaaring ipasok na parameter: template: template na lagda handDrawn: iginuhit na lagda upload: lokal na pag-upload ng larawan ng lagda Maaaring pumili ng marami, paghiwalayin gamit ang ",", default ay lahat ng napili
			movable		boolean	false	Pinapayagang ilipat ang lokasyon kapag lumalagda, default ay false false - hindi pinapayagan ang lumalagda na ayusin ang posisyon ng kanyang sariling mga kontrol sa paglagda true - pinapayagan ang lumalagda na ayusin ang posisyon ng kanyang sariling mga kontrol sa paglagda
			allowedOptions		array	false	Mga opsyon para sa pag-apruba ng lumalagda, naaangkop kung ang fieldType ay approval. Default ay ["approve", "decline"] approve- Sang-ayon decline- Tanggi
			pageNo		string	false	Pahina ng paglagda; ang magkakasunod na pahina ay konektado gamit ang "-", ang mga indibidwal na pahina ay konektado gamit ang "," Halimbawa: 1-3,6-10
			posX		float	false	Coordinate ng x-axis 【Pansin】Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng paglagdaKaliwang 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 na coordinate 【Paalala】Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng pirmaKaliwang 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.
		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 na 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 Kontrol 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 kontrol, default ay 160px
				font	int	false	Para lamang sa text, font, default ay Songti 1-Songti 2-Bagong 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 ay 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 ay itim #000
				bold	boolean	false	Para lamang sa text, kung ang font ay naka-bold, default ay false true-Naka-bold false-Hindi naka-bold
				italic	boolean	false	Para lamang sa text, kung italic, default ay false true-Italic false-Hindi italic
				underline	boolean	false	Para lamang sa text, kung may salungguhit, default ay false true-May salungguhit false-Walang salungguhit
				lineThrough	boolean	false	Para lamang sa text, kung may strike-through, default ay false true-May strike-through false-Walang strike-through
				horizontalAlignment	string	false	Para lamang sa text, format ng horizontal alignment, default ay left LEFT-Nasa kaliwa CENTER-Nasa gitna RIGHT-Nasa kanan
			tickBoxField		object	false	Mga Katangian ng Checkbox
				tickOptions	array	false	Para lamang sa tickBox, default ay 1 1-Tsek 2-Ekis
			posX		float	false	X coordinate ng posisyon ng control
			posY		float	false	Y coordinate ng posisyon ng control
			pageNo		string	false	Numero ng pahina kung saan naroroon ang control
		signDateConfigs			array	false	Impormasyon sa posisyon ng petsa ng pagpirma
			movable		boolean	false	Pinapayagang ilipat ang posisyon sa pagpirma, default ay false false-Hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanyang sariling control sa pagpirma true-Pinapayagan ang lumagda na ayusin ang posisyon ng kanyang sariling control sa pagpirma
			pageNo		string	false	Pahina ng pagpirma; ang magkasunod na pahina ay konektado gamit ang "-", ang mga indibidwal na pahina ay konektado gamit ang ","，Halimbawa: 1-3, 6-10; Kung hindi magkasunod, ipasa ang "," para sa paghihiwalay.
			posX		float	false	x-axis offset, ang lower left corner ng pahina ay ang pinagmulan ng coordinate
			posY		float	false	Y-axis offset, ang ibabang kaliwang sulok ng pahina ang pinagmulan ng coordinate
			signDateFormat		string	false	Format ng petsa ng pagpirma, ang default na format ay yyyy-MM-dd Suportado 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	Envelope ID
CCInfos		array	Koleksyon ng impormasyon ng CC
	userEmail	string	Email address ng CC
	userName	string	Pangalan ng CC
signFiles		array	Koleksyon ng impormasyon ng dokumento ng pagpirma
	fileKey	string	FileKey ng dokumento ng pagpirma
attachments		array	Koleksyon ng mga kalakip sa sobre
	fileKey	string	File fileKey
signerInfos		array	Impormasyon sa pagpirma
	businessId	string	Custom na numero ng negosyo ng developer, limitasyon sa haba na 500
	userEmail	string	Email address ng lumagda
	userName	string	Pangalan ng lumagda
	signUrl	string	Link ng address sa pagpirma
	signOrder	int	Pagkakasunud-sunod ng pagpirma ng lumagda, ang pinakamababa ay 1
	accessCode	string	Password sa pag-access sa pahina ng pagpirma

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