Magdagdag ng lumagda

POST/esignglobal/v1/envelope/recipients/addSigners

Paglalarawan ng Interface

Magdagdag ng mga lumagda sa isang sobre, ang lumagda ay ang gawain sa paglagda. Kabilang dito ang pagdaragdag ng mga kontrol, mga paraan ng pagpapatunay ng pagkakakilanlan, atbp. para sa lumagda.

Pansin:

Sinusuportahan ang pagdaragdag ng mga bagong lumagda pagkatapos buksan ang sobre. Ang pagkakasunud-sunod ng paglagda ng mga bagong idinagdag na lumagda ay hindi maaaring mas mababa o katumbas ng halaga ng pagkakasunud-sunod ng paglagda ng sinumang lumalagda na kasalukuyang lumalagda.
Ang parehong lumagda (gamit ang email bilang natatanging identifier ng user) ay hindi pinapayagang idagdag nang paulit-ulit. Kung kailangan mong i-update ang impormasyon ng gawain sa paglagda, mangyaring idagdag muli ang kaukulang lumagda.
Maaari lamang magkaroon ng maximum na 10 lumagda sa isang sobre.

Mga Parameter ng Kahilingan

Pangalan ng Parameter					Uri	Kinakailangan	Paglalarawan
envelopeId					string	true	Envelope ID
signerInfos					array	true	Koleksyon ng Impormasyon ng Lumagda
	businessId				string	false	Custom na numero ng negosyo na tinukoy ng developer, haba 500
	userEmail				string	true	Email address ng lumagda
	phoneNumber				object	false	Kinakailangan kapag kailangang magsagawa ng abiso sa SMS, kailangang ipasok ang countryCode at number, default ay walang laman
		countryCode			string	false	International code ng bansa/rehiyon, hindi na kailangang ipasok ang “+”
		number			string	false	Hindi nagsasagawa ng pag-verify ng format, ang maximum na haba ay 13 digits
	customizeSettings				object	false	Custom na configuration
		notificationSettings			object	false	Custom na configuration para sa mga notification
			customizeMessage		string	false	Eksklusibong notification ng mensahe, limitasyon sa karakter na 200
			notificationLanguage		string	false	Wika ng notification, default ay Ingles en-US Ingles zh-CN Pinasimpleng Tsino zh-Hant Tradisyunal na Tsino ja-JP Hapon ES-MX Espanyol
	userName				string	true	Pangalan ng lumagda, ginagamit para ipakita ang pangalan ng lumagda sa panlabas na pahina at proseso ng paglagda. 【Paalala】Hindi maaaring maglaman ng sumusunod na 9 na espesyal na karakter: / \ : * " < > \| ？at lahat ng emoji
	signOrder				int	true	Pagkakasunod-sunod ng paglagda ng lumagda, ang pinakamababa ay 1. Maaaring tukuyin ang parehong halaga ng pagkakasunod-sunod para sa walang-ayos na paglagda.
	anySigner				boolean	false	Kung sinusuportahan ang paglagda ng kahit sinong isa, default ay false true-Isa lamang sa parehong signOrder ang kailangang lumagda false-Lahat sa parehong signOrder ay kailangang lumagda
	authModes				string	false	Paraan ng pagpapatunay ng pagkakakilanlan, default ay noAuth Uri ng enumeration: noAuth-Hindi nagpapatunay accessCode-Gumagamit ng password sa paglagda para sa pagpapatunay sms-SMS OTP na pagpapatunay idVerification-Pagpapatunay ng ID emailAuth- Pagpapatunay ng OTP sa Email digitalId- Pagpapatunay ng Elektronikong Pagkakakilanlan
	authConfig				object	false	Mga Setting ng Paraan ng Pagpapatunay
		accessCode			object	false	Mga setting ng password sa pagpirma, kinakailangan kapag authModes=accessCode
			accessCode		string	false	Nilalaman ng password, hindi sensitibo sa kaso, maaaring maglaman ng mga alphanumeric na character, haba 45
			promptInfo		string	false	Paalala sa access token, hindi maaaring maglaman ng access token, limitasyon sa haba na 30, kapag ang authModes=accessCodeay kinakailangan.
		sms			object	false	SMS OTP na pagpapatunay, kapag ang authModes=smsay kinakailangan
			countryCode		string	false	Internasyonal na code ng bansa/rehiyon, hindi na kailangan ang “+”
			number		string	false	Hindi ginagawa ang pagpapatunay ng format, ang maximum na haba ay 13 digits
		idVerification			object	false	Mga setting ng pagpapatunay ng ID, kinakailangan kapag ang authModes=idVerificationay
			name		string	false	Buong pangalan sa ID ng lumagda, maximum na haba ng 100 character
		emailAuth			object	false	Pagpapatunay ng email OTP, kinakailangan kapag ang authModes=emailAuthay
			authEmail		string	false	Email address para sa pagpapatunay ng pagkakakilanlan ng lumagda
		digitalId			array	false	Electronic na pagpapatunay ng pagkakakilanlan, kinakailangan kapag ang authModes=digitalId
			authApp		string	false	APP na ginagamit para sa electronic na pagpapatunay ng pagkakakilanlan singpass-Gumamit ng Singpass para sa pagpapatunay ng pagkakakilanlan
			idNumber		string	false	Numero ng ID ng nagpirma na kailangang patunayan
	digitalSignature				boolean	false	Kung bubuksan ang digital signature, default ay false true-Buksan false- Hindi naka-enable
	freeFormSign				boolean	false	Kung ang lumagda ay malayang lumagda, ang 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 sabay na ipinasa, 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 paglagda ay hindi naglilimita sa bilang at posisyon ng mga selyo/lagda na maaaring i-drag ng lumagda.
	sealInfos				array	false	Impormasyon ng gawain sa paglagda
		fileKey			string	true	fileKey ng dokumento sa paglagda
		signConfigs			array	false	Impormasyon ng posisyon ng control, dapat tukuyin ang impormasyon ng posisyon ng control upang maisagawa ang elektronikong lagda.
			fieldType		string	false	Uri ng kontrol, maaaring ipasok na parameter: signature-Kontrol ng lagda stamp-Kontrol ng selyo approval-Kontrol ng pag-apruba Ang default ay signature
			sizeRule		string	false	Paraan ng pagpapakita ng laki ng lugar ng paglagda originalSize-Ilagay ang selyo ayon sa aktwal na laki ng lagda/selyo targetSize-Custom na taas at lapad ng lugar ng lagda/selyo Kapag ang sizeRule, height, at width ay lahat walang laman, ilagay ang selyo ayon sa aktwal na laki ng lagda/selyo; Kapag walang laman ang sizeRule, at hindi walang laman ang height at width, ilagay ang selyo ayon sa tinukoy na sukat; Kapag hindi walang laman ang sizeRule, ilagay ang selyo ayon sa tinukoy na paraan ng pagpapakita.
			height		int	false	Taas ng control ng pagpirma, naaangkop para sa fieldType na signature/stamp, ang unit ay px, sinusuportahan lamang ang pagpasa ng positibong integer, default na auto (ibig sabihin, awtomatikong sukat ng system); Kapag fieldType=signature, ang saklaw na maaaring itakda ay 20-250px; Kapag 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, ang unit ay px, sinusuportahan lamang ang pagpasa ng positibong integer, default na auto (ibig sabihin, awtomatikong sukat ng system); Kapag fieldType=signature, ang saklaw na maaaring itakda ay 20-250px; Kapag fieldType=stamp, ang saklaw na maaaring itakda ay 30-280px
			signatureOptions		string	false	Mga opsyon para sa signature control. Angkop lamang kung ang fieldType ay signature. Mga posibleng parameter: template handDrawn upload Pwedeng pumili ng marami, paghiwalayin gamit ang ",", default na lahat ay napili
			movable		boolean	false	Payagan ang paglipat ng lokasyon habang lumalagda, default ay false false-Hindi pinapayagan ang lumalagda na ayusin ang posisyon ng kanyang sariling signature control true-Pinapayagan ang lumalagda na ayusin ang posisyon ng kanyang sariling signature control
			allowedOptions		array	false	Mga opsyon na pinapayagan ang mga lumagda na aprubahan, na angkop para sa fieldType na approval. Ang default ay ["approve", "decline"] approve-Sumang-ayon decline-Tanggihan
			pageNo		string	false	Pahina ng paglagda; ang magkakasunod na pahina ay konektado gamit ang "-", ang mga hiwalay na pahina ay konektado gamit ang ",", halimbawa: 1-3, 6-10
			posX		string	false	X-axis coordinate Karagdagang paliwanag: Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng lagdaKaliwang ibabang sulok； Kung ang fieldType ay stamp, ang posisyon ng coordinate ay tumutukoy sa lugar ng pagtatatakGitnang puntoPosisyon Simula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang posisyon ng coordinate ay tumutukoy sa gitnang punto ng lugar ng pagtatatak.
			posY		string	false	Y-axis coordinate Karagdagang paliwanag: Kung ang fieldType ay signature, ang posisyon ng coordinate ay tumutukoy sa lugar ng lagdaKaliwang ibabang sulok； Kung ang fieldType ay stamp, ang posisyon ng coordinate ay tumutukoy sa lugar ng pagtatatakSentrong puntoPosisyon Simula Pebrero 3, 2026, ang fieldType na signature o stamp, ang posisyon ng coordinate nito ay tumutukoy sa sentrong punto ng lugar ng pagtatatak.
		fillConfigs			array	false	Punan ang impormasyon ng kontrol
			fieldName		string	false	Pangalan ng kontrol, limitasyon ng bilang ng karakter ay 128
			required		boolean	false	Kung kinakailangan o hindi, kinakailangan bilang default true-Kinakailangan false-Hindi kinakailangan
			fieldType		string	false	Uri ng Kontrol: 1-Isahang 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 pag-input
				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 ay 160px
				font	int	false	Para lamang sa text, font, default na 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 naka-italic, default ay false true-naka-italic false-hindi naka-italic
				underline	boolean	false	Para lamang sa text, kung ang font ay may salungguhit, default ay false true-may salungguhit false-walang salungguhit
				lineThrough	boolean	false	Para lamang sa text, kung magdagdag ng linya sa gitna, default ay false true-Magdagdag ng linya sa gitna false-Huwag magdagdag ng linya sa gitna
				horizontalAlignment	string	false	Para lamang sa text, format ng pahalang na paggitna, default ay left LEFT-Sa kaliwa CENTER-Nasa gitna RIGHT-Sa kanan
			tickBoxField		object	false	Mga Katangian ng Checkbox
				tickOptions	array	false	Epektibo lamang sa Check, default ay 1 1-Tsek 2-Krus
			posX		float	false	X coordinate ng posisyon ng control
			posY		float	false	Posisyon ng Y coordinate ng control
			pageNo		string	false	Pahina kung saan naroroon ang control
		signDateConfigs			array	false	Impormasyon sa lokasyon ng petsa ng pagpirma
			movable		boolean	false	Pinapayagan ang paglipat ng posisyon kapag pumirma, default ay false false-Hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanilang sariling control sa pagpirma true- Payagan ang lumagda na ayusin ang posisyon ng kanyang sariling mga kontrol sa paglagda
			pageNo		string	false	Bilang ng pahina ng paglagda; ang magkakasunod na bilang ng pahina ay konektado gamit ang "-", ang mga indibidwal na bilang ng pahina ay konektado gamit ang ",", halimbawa: 1-3, 6-10 Kung hindi magkasunod, ipasa ang "," upang paghiwalayin
			posX		float	false	Offset ng x-axis, ang kaliwang ibabang sulok ng pahina ay ang pinagmulan ng coordinate
			posY		float	false	Offset ng y-axis, ang kaliwang ibabang sulok ng pahina ay ang pinagmulan ng coordinate
			signDateFormat		string	false	Format ng petsa ng pagpirma, ang default na format ay yyyy-MM-dd Suportado ang mga tinukoy na format: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd yyyy dd MM yyyy

Halimbawa ng kahilingan

{
    "envelopeId": "{{envelope-id}}",
    "signerInfos": [
        {
    	   "userEmail": "sender_user@esignglobal.com",
    	   "userName": "sender_user_name",
    	   "signOrder": 1,
    	   "authModes": "sms",
           "authConfig": {
                "sms": {
                    "countryCode": "86",
                    "number": "158****9242"
                }
            },
            "sealInfos": [
                {
                    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
                    "signConfigs": [
                        {
                           "fieldType": "stamp",
                            "pageNo": "1",
                            "posX": 100.22,
                            "posY": 100
                        }
                    ],
                    "fillConfigs": [
                        {
                            "fieldId": "df0dd777bcc4d108de242d",
                            "fieldKey": "demo",
                            "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": "96e6c7d414f04e98938ea84013b",
                            "fieldKey": "红色加深斜体下划线删除线",
                            "pageNo": "1",
                            "posX": 94.516624,
                            "posY": 284.54953,
                            "fieldType": "1",
                            "required": false,
                            "textField": {
                                "overflowType": "1",
                                "minFontSize": 10.5,
                                "font": "1",
                                "fontSize": 12.0,
                                "textColor": "#E25041",
                                "bold": true,
                                "italic": true,
                                "lineThrough": true,
                                "horizontalAlignment": "LEFT"
                            }
                        },
                        {
                            "fieldId": "888b899853544c49bd819d9f6d1",
                            "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
signFiles			array	Koleksyon ng mga Nilagdaang Dokumento
	fileKey		string	fileKey ng Nilagdaang Dokumento
attachments			array	Koleksyon ng mga Attachment ng Sobre
	fileKey		string	fileKey ng Dokumento
signerInfos			array	Koleksyon ng Impormasyon ng Lumalagda
	businessId		string	Custom na numero ng negosyo ng developer, haba 500
	userEmail		string	Email address ng lumalagda
	userName		string	Pangalan ng lumagda
	signOrder		int	Pagkakasunod-sunod ng node ng lumagda, ang pinakamababa ay 1
		accessCode	string	Password sa pag-access sa pahina ng paglagda

Halimbawa ng tugon

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "organizationName": "Esign Global CO.",
                "userLastName": "",
                "accessCode": "",
                "userEmail": "sender_user@tsign.cn",
                "userFirstName": "",
                "signOrder": "1"
            }
        ],
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "attachments": [

        ],
        "envelopeId": "9fbe6c8190824227bde29136b0145c81"
    },
    "message": "success"
}