eSign.AIeSign.AI
Sentro ng developer

Mabilis na Simulan ang Envelope

POST /esignglobal/v1/envelope/createAndStart

Deskripsyon ng Interface

Mabilis na pag-imbita ng envelope, kabilang ang paglikha ng envelope, pagdaragdag ng mga file na handa nang ipirmahan, at pagdaragdag ng mga tagapirmahan.

  • Suportado ang awtomatikong pagbukas: Matapos ang matagumpay na tawag sa interface, matagumpay na nalikha at nabuksan ang envelope, at nagsisimula itong daloy nang awtomatiko.
  • Suportado ang awtomatikong pagtapos: Kapag natapos na ng lahat ng mga party na nagpirmahan ang kanilang pagpirma, awtomatikong tatapos ang envelope.

 

Mga Parameter ng Hiling

Pangalan ng Parameter

Uri

Kailangan

Paliwanag

subject

string

true

Paksa ng Envelope

Halimbawa: "Offer Letter"

remark

string

false

Tala ng Envelope, limitasyon ng haba ay 1000 karakter

signerSettings

object

false

Mga Aksyon na Pinapayagan ng Tagapirmahan

 

allowTransfer

boolean

false

Pinapayagan ba na ipaipasa ng tagapirmang ito ang envelope sa iba para pumirma, default false

true-Pinapayagan ang mga tagapirmang nasa envelope na magpaipasa ng envelope sa iba;

false-Hindi pinapayagan ang mga tagapirmang nasa envelope na magpaipasa ng envelope sa iba;

 

allowModifyName

boolean

false

Pinapayagan ba na baguhin ng tagapirmang ang pangalan, lamang para sa template signature, default false

true-Pinapayagan ang tagapirmang baguhin ang pangalan

false-Hindi pinapayagan ang tagapirmang baguhin ang pangalan

expireAfterSeconds

long

false

Oras ng expiration ng envelope, pagkatapos ng ilang segundo ay magiging expired ang envelope

Saklaw ng expiration: 86,400 segundo (1 araw) ~ 7,776,000 segundo (90 araw)

redirectUrl

string

false

Dapat maging valid na https address

callBackUrl

string

false

Callback address (length 500), dapat sumunod sa https protocol address.

sendLaterAfterSeconds

long

false

Suportado ang delayed sending ng user, sa units ng segundo

Saklaw ng oras: 3600 segundo (1 oras) ~ 259200 segundo (30 araw)

autoFinish

boolean

false

Kontrol kung ang envelope ay awtomatikong matatapos, default true

true-Awtomatikong matatapos ang envelope

false-Manwal na matatapos ang envelope

CCInfos

array

false

Koleksyon ng impormasyon ng mga kopya

 

userEmail

string

false

Email address ng mga kopya

 

userName

string

false

Pangalan ng kopya, ginagamit sa pahina ng pag-sign at sa panlabas na ipinapakita ng envelope para sa pangalan ng kopya.

[Paalala]: Huwag maglaman ng sumusunod na 9 espesyal na character: / \ : * " < > | ? at lahat ng emoji

 

ccOrder

int

false

Posisyon ng order ng kopya sa proseso ng pag-sign, nagbabahagi ng order sa signOrder ng mga nagsign. Kapag hindi ipinasa, gagamitin ang orihinal na lohika ng abiso ng kopya.

 

customizeSettings

object

false

Custom na configuration

 

 

notificationSettings

object

false

Abiso na custom na configuration

 

 

 

notificationLanguage

string

false

Wika ng abiso, default na kinukuha mula sa 'Default na wika ng abiso' configuration

en-US Ingles

zh-CN Simplified Chinese

zh-Hant Traditional Chinese

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 German
fr-FR French
ru-RU Russian
it-IT Italian
ko-KR Korean

signFiles

array

true

Koleksyon ng impormasyon sa mga dokumentong sinusubskriben, ipinapakita ayon sa pagkakasunod ng pagdaragdag ng dokumento.

 

fileKey 

string

true

fileKey ng dokumentong sinusubskriben, suportado lamang ang format na PDF

 documentFieldsarrayfalseListahan ng mga kontrol sa dimensyon ng dokumento. Ginagamit upang magdagdag ng mga kontrol sa dimensyon ng dokumento na hindi nakatali sa anumang tagapagsubscribe sa isang itinakdang dokumento.

 

 

fieldType

string

false

Uri ng kontrol. Ipadala ang eMeterai upang kumakatawan sa kontrol ng stamp duty ng Indonesia.

 

 

pageNo

string

false

Numero ng pahina kung saan matatagpuan ang kontrol. Ang kontrol ng stamp duty ng Indonesia ay suportado lamang ang pagtatakda ng iisang pahina, kailangan ipadala ang iisang numero ng pahina, hindi suportado ang format ng tuloy-tuloy o hindi tuloy-tuloy na maraming pahina gaya ng 1-3, 1,3, atbp.

  posXfloatfalseOffset sa x-axis, ang ibabang kaliwang sulok ng pahina ang pinagmulan ng koordinado. Ang saklaw ng koordinado ay katumbas ng saklaw ng koordinado ng iba pang mga kontrol.
  posYfloatfalseOffset sa axis ng y, ang kaliwang ibaba ng pahina ang pinagmulan ng koordinado. Ang saklaw ng koordinado ay katumbas ng saklaw ng koordinado ng iba pang mga kontrol.

attachments

array

false

Koleksyon ng mga attachment na envelope, ang sunod-sunod na pagpapakita ay ayon sa order ng pagdaragdag ng file.

 

fileKey 

string

false

fileKey ng file

signerInfos

array

true

Koleksyon ng impormasyon ng tagapirmahan

 

businessId

string

false

Custom na business number ng developer, limitasyon ng haba 500

 

roleTypes

array

false

Paraan ng operasyon ng tagapirmahan, default na halaga ay ["sign", "fill"]

fill-punan

sign-pirmahan

 deliveryMethods

string

false

Paraan ng abiso, default na auto

auto-Kapag ipinapasa ang userEmail, magpadala ng email notification; kapag ipinapasa ang phoneNumber, magpadala ng SMS notification

none-Hindi magpadala ng mensahe notification

email-Magpadala ng email notification

sms-Magpadala ng SMS notification

WhatsApp-Magpadala ng WhatsApp notification

 

userEmail

string

false

Email address ng tagapirmahan

 

userName

string

true

Pangalan ng nagpirmahan, ginagamit upang ipakita ang pangalan ng nagpirmahan sa pahina ng pagpirmahan at sa panlabas na pagpapakita ng envelope.

[Tandaan] Hindi dapat maglaman ng sumusunod na 9 espesyal na karakter: / \ : * " < > | ? at lahat ng emoji

 minimumReadingDurationintfalseItakda ang oras ng countdown para sa mandatory na pagbabasa sa pahina ng setting, default na halaga ay 0 (yunit: segundo, maximum na halaga 999)
Ang 0 o hindi pagpapadala ay nangangahulugang hindi isinasara, walang countdown para sa pagbabasa
 readToEndRequiredbooleanfalseNagpapahiwatig kung kailangan bang basahin hanggang dulo. Default na false;
true ay nangangahulugang isinasara, false o hindi pagpapadala ay nangangahulugang hindi isinasara.

 

phoneNumber

object

false

Numero ng telepono, default na walang laman

Kailangang punan kapag kailangan ng SMS notification, kailangang ipadala ang countryCode at number

 

 

countryCode

string

false

International code ng bansa/rehiyon, hindi kailangang ipadala ang "+"

 

 

number

string

false

Walang format validation, limitasyon lamang sa haba na maximum na 13 digit

 

customizeSettings

object

false

Custom configuration

 

 

notificationSettings

object

false

Custom configuration para sa mga notification

 

 

 

customizeMessage

string

false

Exclusive message notification, limitasyon sa character na 200

   

notificationLanguage

string

false

Wika ng notification, default na kinukuha mula sa configuration ng "default na wika ng notification"

en-US Ingles

zh-CN Simplified Chinese

zh-Hant Traditional Chinese

ja-JP Japanese

es-MX Spanish

pt-PT Portuguese
th-TH Thai
id-ID Indonesian
vi-VN Vietnamese
ms-MY Malay
fil-PH Filipino
de-DE German
fr-FR French
ru-RU Russian
it-IT Italian
ko-KR Korean

 

signOrder

int

true

Ang sunod-sunod na pagpirma ng tagapirmahan, pinakamababa ay 1. Maaaring magtakda ng parehong halaga ng order para sa unordered signing.

 

signTaskSuspend

boolean

false

Kung itatakda ba ang isang node ng proseso ng paghahadlang bago ang posisyong ito ng pagpirma, default ay false. true-itatakda ang node ng hadlang; false-hindi itatakda ang node ng hadlang. Ang konfigurasyon ng hadlang sa loob ng grupo ng or-sign na may parehong signOrder ay dapat magkapareho.

 

suspensionKey

string

false

ID ng node ng hadlang, pinakamahaba ay 500 na karakter, natatangi sa loob ng parehong envelope. Kailangan kapag signTaskSuspend=true; hindi dapat ipasa kapag signTaskSuspend=false o hindi ipasa.

 

suspendReason

string

false

Dahilan ng hadlang, hindi dapat walang laman kapag ipinasa, pinakamahaba ay 50 na karakter. Maaaring ipasa lamang kapag signTaskSuspend=true; kung hindi ipasa, ang default ay nangangahulugan na kailangang hintayin ang pagproseso ng external system. Hindi dapat ipasa kapag signTaskSuspend=false o hindi ipasa.

 

anySigner

boolean

false

Kung sinusuportahan ba ng kahit sino ang pagpirma, default ay false

true-Isa lang sa mga tao sa parehong signOrder ang kailangang sumign

false-Lahat ng tao sa parehong signOrder ay kailangang sumign

 

authModes

string

false

Paraan ng pagpapatunay, default ay noAuth

noAuth-Hindi magpapatunay

accessCode-Gamitin ang password ng pagpirma para sa pagpapatunay

sms-SMS OTP verification

idVerification-Pagpapatunay gamit ang ID card

emailAuth-Email OTP verification

digitalId-Electronic identity verification

whatsappAuth-WhatsApp OTP verification

 

authConfig

object

false

Pag-set up ng Paraan ng Pagpapatunay

 

 

accessCode

object

 

false

Pag-set up ng Passphrase, kapag ang authModes=accessCodeay kinakailangan

 

 

 

accessCode

string

false

Nilalaman ng passphrase, hindi sensitive sa case, maaaring maglaman ng mga letra at numero, limitasyon ng haba ay 45

   

promptInfo

string

false

Paalala para sa Access Passphrase, hindi dapat maglaman ng access passphrase, limitasyon ng haba ay 30, kapag ang authModes=accessCodeay kinakailangan.  

 

 

sms

object

false

SMS OTP verification, kapag ang authModes=smsay kinakailangan

 

 

 

countryCode

string

false

International code ng bansa o rehiyon, huwag isama ang “+”

 

 

 

number

string

false

Walang format validation, lamang limitasyon sa haba na maximum 13 digits

 

 

idVerification

object

false

Pag-set up ng Verifikasyon ng ID, kapag ang authModes=idVerificationay kinakailangan

 

 

 

name

string

false

Buong pangalan sa ID ng tagapirmian, maximum na haba ay 100 characters

  

emailAuth

object

false

Email OTP verification, kapag ang authModes=emailAuthay kinakailangan

  

 

authEmail

string

false

Email address para sa pagpapatunay ng identidad ng nag-sign

 

 

digitalId

array

false

Elektronikong pagpapatunay ng identidad, kailangan kapag authModes=digitalId

 

 

 

authApp

string

false

APP na ginagamit para sa elektronikong pagpapatunay ng identidad

singpass-Paggamit ng Singpass para sa pagpapatunay ng identidad

iamsmart-Paggamit ng i AM Smart para sa pagpapatunay ng identidad

 

 

 

idNumber

string

false

Numero ng ID card ng nag-sign na nasa hinihintay na pagpapatunay

Kapag authApp=singpass, ang format ng input ay: uppercase letter + 7 o 8 digit number + uppercase letter

Kapag authApp=iamsmart, ang format ng input ay:

1. Isang uppercase letter (A-Z), o dalawang uppercase letters (AA-ZZ), bilang simula ng sequence;

2. Sinundan ng 6 digit number;

3. Huli ay isang check digit, maaaring numero (0-9) o letra (A-Z). Halimbawa: A888888(A)

 

 

whatsappAuth

object

false

WhatsApp OTP verification, kailangan kapag authModes=whatsappAuth

 

 

 

countryCode

string

false

International code ng bansa/rehiyon, huwag ipasok ang “+”

 

 

 

number

string

false

Hindi magpapatunay ng format, limitahan lamang ang haba na maximum ay 13 digits

 

digitalSignature

boolean

false

Iba-iba kung gagawing bukas ang digital signature, default false

true-bukas, false-hindi bukas

 

tsp

string

false

Pumili ng TSP na ginagamit ng tagapirmi, default false.

Kung hindi itatakda, pinipili ng tagapirmi ang kailangan gamitin na TSP. Kasama sa enumeration:

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni

belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia

estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom

harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId

mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign

smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe

certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha

 

freeFormSign

boolean

false

Bawal ba sa tagapirmi na gumamit ng free form sign, default value false

Karagdagang paliwanag:

Kapag napili ang freeFormSign bilang true, hindi na kailangang ipasa ang ibang parameter sa ilalim ng sealInfos. Kung sabay-sabay na ipinasa, mas mataas ang priority ng freeFormSign kaysa sa sealInfos, at hindi gagana ang mga parameter sa ilalim ng sealInfos

[Paalala]Ang free form sign ay nangangahulugang walang limitasyon sa bilang at posisyon ng mga selyo/signature na maaaring i-drag ng tagapirmi

 

documentVisibility

object

false

Konpigurasyon ng visibility ng file, default lahat ay visible.

 

 

documentViewType

string

false

Stratehiya ng visibility, default all; all ay nagpapahintulot na makita ang lahat ng dokumento sa loob ng envelope, limited ay nagpapahintulot lamang na makita ang sariling nagsign na dokumento at karagdagang nakikita na dokumento.

 

 

viewableFileKeys

array

false

Listahan ng fileKey na extra pinapayagan para sa panonood ng tagapirmi; pinapayagang ipasa at gagana lamang kapag documentViewType=limited.

 

sealInfos

array

false

Impormasyon tungkol sa task ng pag-sign

 

 

fileKey

string

true

fileKey ng dokumentong sinisign

 

 

signConfigs

array

false

Impormasyon sa lokasyon ng kontrol, kailangang tukuyin ang impormasyon sa lokasyon ng kontrol upang makagawa ng electronic signature.

 

 

 

fieldType

string

false

Uri ng kontrol, default ay signature

signature-Signature control

stamp-Seal control

approval-Approval control

   

required

boolean

false

Kailangan ba ito, default ay required

true-Required

false-Optional

   

signFieldStyle

string

false

Paraan ng paglalagay ng seal sa signature control, default ay normalSeal.

normalSeal-Karaniwang seal

pagingSeal-Cross-page seal

Ang cross-page seal ay suportado lamang sa signature control at seal control.

   

pagingSealMode

string

false

Saklaw ng mga pahina para sa cross-page seal, default ay all.

all-Lahat ng page numbers

assignedPages-Tukuyin ang page numbers

even-Makulian na pahina

odd-Kumpletong pahina

Suportado lamang kapag ang signFieldStyle=pagingSeal.

   

sizeRule

string

false

Paraan ng pagpapakita ng sukat ng lugar ng pag-sign

originalSize-Ilagay ang tatak ayon sa aktwal na sukat ng lagda/tatak

targetSize-I-customize ang lapad at taas ng lugar ng lagda/tatak

Kapag ang sizeRule, height, at width ay walang laman, ilalagay ang tatak ayon sa aktwal na sukat ng lagda/tatak;

Kapag ang sizeRule ay walang laman, ngunit ang height at width ay may laman, ilalagay ang tatak ayon sa tinukoy na sukat;

Kapag ang sizeRule ay may laman, ilalagay ang tatak ayon sa tinukoy na paraan ng pagpapakita;

Hindi kailangan itakda ang parameter na ito para sa paging seal; ilalagay lamang ayon sa aktwal na sukat.

 

 

 

height

int

false

Taas ng kontrol sa pag-sign, angkop kapag ang fieldType ay signature/stamp, ang unit ay px, suportado lamang ang positibong buong numero, default ay auto (i.e., awtomatikong sukat ng sistema);

Kapag ang fieldType=signature, ang sakop ng pag-set ay 20-250px;

Kapag ang fieldType=stamp, ang sakop ng pag-set ay 30-280px;

Hindi kailangan itakda ang parameter na ito para sa paging seal.

 

 

 

width

int

false

Lapad ng kontrol sa pag-sign, angkop kapag ang fieldType ay signature/stamp, ang unit ay px, suportado lamang ang positibong buong numero, default ay auto (i.e., awtomatikong sukat ng sistema);

Kapag ang fieldType=signature, maaaring itakda ang saklaw sa 20-250px;

Kapag ang fieldType=stamp, maaaring itakda ang saklaw sa 30-280px;

Hindi kinakailangang tukuyin ang parameter na ito para sa seal na nakasabit sa gilid.

 

 

 

signatureOptions

string

false

Mga opsyon ng kontrol sa pag-sign. Ito ay lamang para sa fieldType na signature

Maaaring ipasok:

template: template na sign

handDrawn: hand-drawn na sign

upload: lokal na upload na larawan ng sign

aiHandDrawn: AI na handwritten na sign

Maaaring pumili ng maramihan, hiwalay gamit ang ",", default ay lahat

 

 

 

movable

boolean

false

Pinapayagan ang paggalaw ng posisyon habang nagse-sign, default ay false

false-hindi pinapayagan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign

true-pinaaayalagan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign

 

 

 

allowedOptions

array

false

Mga opsyon para sa pag-apruba ng taga-sign, para sa fieldType na approval. Default ay ["approve", "decline"]

approve-Tanggap

decline-Tanggihan

 

 

 

pageNo

string

false

Mga pahina ng pag-sign; ang mga sunod-sunod na pahina ay idinudugtong gamit ang "-", at ang mga hiwalay na pahina ay idinudugtong gamit ang ","

Halimbawa: 1-3,6-10

Kapag ang pagingSealMode=assignedPages, ipasa ang saklaw ng mga pahina kung saan ilalagay ang骑缝章 (seal na sumasakop sa maraming pahina). Ang骑缝章 ay maaari lamang gamitin sa mga dokumentong may higit sa isang pahina.

 

 

 

posX

float

false

Koordinado sa x-axis

[Paalala] Kung ang fieldType ay signature, ang lokasyon ng koordinado ay tumutukoy sa lugar ng lagda.Kulay sa kaliwa;

Kung ang fieldType ay stamp, ang lokasyon ng koordinado ay tumutukoy sa lugar ng pag-stamp.Gitnang puntoLokasyon

Simula noong Pebrero 3, 2026, kapag ang fieldType ay signature o stamp, ang lokasyon ng koordinado ay tumutukoy sa gitnang punto ng lugar ng pag-stamp.

Para sa骑缝章, maaaring ipasa ang 0, hindi maaaring ipasa ang null. Ang kontrol ay nakafix sa kanang gilid ng dokumento.

 

 

 

posY

float

false

Koordinado sa y-axis

[Paalala] Kung ang fieldType ay signature, ang lokasyon ng koordinado ay tumutukoy sa lugar ng lagda.Kulay sa kaliwa;

Kung ang fieldType ay stamp, ang lokasyon ng koordinado ay tumutukoy sa gitnang punto ng lugar para sa pag-stamp.Gitnang PuntoLokasyon

Mula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang lokasyon ng koordinado ay tumutukoy sa gitnang punto ng lugar para sa pag-stamp.

 

 

fillConfigs

array

false

Punan ang impormasyon ng control

 

 

 

fieldName

string

false

Pangalan ng control, limitasyon ng karakter na 128

 

 

 

required

boolean

false

Kailangan ba itong punan, default ay kailangan

true - Kailangan

false - Hindi kailangan

 

 

 

fieldType

string

false

Uri ng control:

1 - Single-line na teksto

15 - Checkbox

 

 

 

textField

object

false

Atributo ng text control

 

 

 

 

overflowType

int

false

Epektibo lamang para sa text, default na 1

1 - Awtomatikong pababaan ang laki ng font

2-Limit input

 

 

 

 

minFontSize

float

false

Only applies to text, only applies when overflowType=1, default is 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

Control width, default is 160px

 

 

 

 

font

int

false

Only applies to text, font, default is SimSun

1-SimSun

2-New SimSun

4-HeiTi

5-KaiTi

6-Arial

7-Helvetica

9-Times New Roman

10-FangSong

11-Georgia

12-Monospace

 

 

 

 

fontSize

float

false

Only applies to text, font size, default is 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

Only applies to text, hexadecimal color, default is black #000

 

 

 

 

bold

boolean

false

Only applies to text, whether the font is bold, default is false

true-Bold

false-Not bold

 

 

 

 

italic

boolean

false

Only applies to text, whether italic, default is false

true-italics

false-hindi italics

 

 

 

 

underline

boolean

false

Dapat lamang sa text, kung may underline ang font, default false

true-add underline

false-no underline

 

 

 

 

lineThrough

boolean

false

Dapat lamang sa text, kung may strikethrough, default false

true-add strikethrough

false-no strikethrough

 

 

 

 

horizontalAlignment

string

false

Dapat lamang sa text, horizontal alignment format, default left

LEFT-align left

CENTER-center

RIGHT-align right

 

 

 

tickBoxField

object

false

Checkbox properties

 

 

 

 

tickOptions

array

false

Dapat lamang sa tickBox, default 1

1-checked

2-aklat

 

 

 

posX

float

false

X koordinado ng posisyon ng kontrol

 

 

 

posY

float

false

Y koordinado ng posisyon ng kontrol

 

 

 

pageNo

string

false

Numero ng pahina kung saan matatagpuan ang kontrol

 

 

signDateConfigs

array

false

Impormasyon sa posisyon ng petsa ng pagpirma

 

 

 

movable

boolean

false

Pinapayagan na ilipat ang posisyon sa panahon ng pagpirma, default ay false

false-hindi pinapayagan ang nagpirmang baguhin ang posisyon ng kanyang mga kontrol sa pagpirma

true-pinapayagan ang nagpirmang baguhin ang posisyon ng kanyang mga kontrol sa pagpirma

 

 

 

pageNo

string

false

Numero ng pahina ng pagpirma; ang magkasunod na numero ng pahina ay idinudugtong gamit ang "-", at ang hiwalay na numero ng pahina ay hinahati gamit ang ",", halimbawa: 1-3, 6-10;

Kung hindi magkasunod, ipasa ang "," upang hatiin.

 

 

 

posX

float

false

Offset sa x-axis, ang kaliwang ibabang sulok ng pahina ang orihinal na punto ng koordinado

 

 

 

posY

float

false

Offset sa y-axis, ang kaliwang ibabang sulok ng pahina ang orihinal na punto ng koordinado

 

 

 

signDateFormat

string

false

Format ng petsa ng pagpirma, ang default na format ay yyyy-MM-dd

Suportado ang pagtatakda ng format:

yyyy taon MM buwan dd araw

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

Halimbawa ng Hiling

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "CCInfos": [
      {
        "userEmail": "cc_user@esignglobal.com",
        "userName": "cc_user_name",
        "ccOrder": 1
      }
    ],
    "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,
        "signTaskSuspend": true,
        "suspensionKey": "approval-node-001",
        "suspendReason": "等待外部审批",
        "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

Paliwanag

envelopeId

string

ID ng Envelope

CCInfos

array

Koleksyon ng Impormasyon ng CC Recipient

 

userEmail

string

Email Address ng CC Recipient

 

userName

string

Pangalan ng CC Recipient

signFiles

array

Koleksyon ng Impormasyon ng Signed Document

 

fileKey

string

fileKey ng Signed Document

attachments

array

Koleksyon ng Attachments ng Envelope

 

fileKey

string

fileKey ng File

signerInfos

array

Impormasyon ng Pag-sign

 

recipientId

string

ID ng Signer

 

businessId

string

Ang developer ay nagtatakda ng custom na business number, may limit sa haba na 500

 

userEmail

string

Email address ng tagapirmian

 

userName

string

Pangalan ng tagapirmian

 signUrlstringURL ng link para sa pagpirmahan

 

signOrder

int

Sunod-sunod na pagkakasunod ng tagapirmian, pinakamababa ay 1

 

accessCode

string

Password para sa access sa pahina ng pagpirmahan

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