Pangalan ng Parameter | Uri | Kailangan ba? | Paliwanag |
envelopeId | string | true | ID ng Envelope |
signerInfos | object | true | Impormasyon ng Tagapirmá |
| recipientId | string | true | ID ng Partikipe |
| businessId | string | false | Custom na Business Number ng Developer, limitasyon sa haba ay 500 |
| deliveryMethods | string | false | Paraan ng abiso, default ay auto auto-kapag ipinasa ang userEmail, nagpapadala ng email notification; kapag ipinasa ang phoneNumber, nagpapadala ng SMS notification none-hindi nagpapadala ng anumang message notification email-nagpapadala ng email notification sms-nagpapadala ng SMS notification WhatsApp-nagpapadala ng WhatsApp notification |
| userEmail | string | false | Email address ng Tagapirmá |
| userName | string | true | Pangalan ng Tagapirmá, ginagamit upang ipakita ang pangalan ng tagapirmá sa pahina ng pagpirma at sa envelope. [Paalala] Hindi dapat maglaman ng mga sumusunod na 9 na espesyal na karakter: / \ : * " < > | ? at lahat ng emoji |
| | minimumReadingDuration | int | false | Itakda ang oras ng countdown para sa pilit na pagbabasa ng pahina, default na halaga ay 0 (yunit: segundo, maximum na 999) Ang 0 o ang kawalan ng pagpasa ay nangangahulugang hindi pinagana, walang kinakailangang countdown sa pagbabasa |
| | readToEndRequired | boolean | false | Nagpapahiwatig kung dapat ba itong basahin hanggang dulo. Default ay false; Ang true ay nangangahulugang naka-enable, habang ang false o ang hindi pagbibigay ay nangangahulugang naka-disable. |
| phoneNumber | object | false | Numero ng telepono, default na walang laman Kinakailangang punan kapag kailangan ng SMS notification; kailangan ipasok ang countryCode at number. |
| | countryCode | string | false | International code ng bansa o rehiyon, hindi kailangang maglagay ng '+' |
| | number | string | false | Walang format validation, limitado lamang ang haba sa maximum na 13 karakter. |
| customizeSettings | object | false | Custom na configuration |
| | notificationSettings | object | false | Custom na configuration para sa mga notification |
| | | customizeMessage | string | false | Espesyal na mensaheng notification, limitasyon ng karakter ay 200 |
| | | notificationLanguage | string | false | Wika ng notification, default na kinukuha ang configuration ng 'default na wika ng notification' en-US Ingles zh-CN Simplified na Tsino zh-Hant Traditional na Tsino ja-JP Hapon es-MX Espanyol pt-PT Portuges th-TH Thai id-ID Indonesyo vi-VN Biyetnames ms-MY Malayo fil-PH Pilipino de-DE Aleman fr-FR Pranses ru-RU Ruso it-IT Italyano ko-KR Koreano |
| authModes | string | false | Paraan ng pagpapatunay, naka-default na noAuth noAuth-Walang pagpapatunay accessCode-Pagpapatunay gamit ang passphrase sa pagpirma sms-Pagpapatunay ng SMS OTP idVerification-Pagpapatunay ng dokumentong pang-identidad emailAuth-Pagpapatunay ng OTP sa email digitalId-Pagpapatunay ng Digital na Identidad whatsappAuth-Pagpapatunay ng OTP sa WhatsApp |
| authConfig | object | false | Mga Setting ng Paraan ng Pagpapatunay |
| | accessCode | object | false | Mga Setting ng Password sa Pagsisignatura, kailangan kapag ang authModes=accessCode |
| | | accessCode | string | false | Nilalaman ng password, hindi sensitive sa case, maaaring maglaman ng mga letra at numero, limitadong haba ay 45 |
| | | promptInfo | string | false | Paalala para sa access password, hindi dapat kasama ang access password mismo, limitadong haba ay 30, kailangan kapag ang authModes=1. |
| | sms | object | false | Pagpapatunay ng SMS OTP, kailangan kapag ang authModes=sms |
| | | countryCode | string | false | International code ng bansa o rehiyon, hindi kailangang isama ang “+” |
| | | number | string | false | Walang pag-suri ng format, limitadong maximum na haba ay 13 na character |
| | idVerification | object | false | Mga Setting ng Pagpapatunay ng ID, kailangan kapag ang authModes=idVerification |
| | | name | string | false | Buong pangalan sa ID ng nag-signature, maximum na haba ay 100 na character |
| | emailAuth | object | false | Pagpapatunay ng OTP sa email, kailangan kapag ang authModes=emailAuth |
| | | authEmail | string | false | Email address para sa pagpapatunay ng identidad ng nag-signature |
| | digitalId | array | false | Pagpapatunay ng digital na identidad, kailangan kapag ang authModes=digitalId |
| | | authApp | string | false | App na ginagamit sa e-pagpapatunay ng identidad singpass-Gamitin ang Singpass para sa pagpapatunay ng identidad |
| | | idNumber | string | false | Numero ng ID ng tagapirmang pipagtibayan |
| | whatsappAuth | object | false | Pagpapatunay ng OTP sa WhatsApp, kinakailangan kapag ang authModes=whatsappAuth |
| | | countryCode | string | false | Pandaigdigang code ng bansa o rehiyon, hindi kailangang magpasok ng “+” |
| | | number | string | false | Walang pag-validate ng format, limitado lamang ang haba sa maximum na 13 digit |