建立信封

POST /esignglobal/v1/envelope/create

介面描述

建立草稿狀態的信封。

請求參數

參數名稱		類型	是否必填	說明
subject		string	true	信封主題，範例：“Offer Letter”
remark		string	false	信封備註，長度限制 1000字
signerSettings		object	false	允許簽署人進行的操作
	allowTransfer	boolean	false	是否允許簽署人將該信封轉交給其他人簽署，預設false true-允許信封中的簽署人擁有信封轉交他人的權力； false-不允許信封中的簽署人擁有信封轉交他人的權力；
	allowModifyName	boolean	false	是否允許簽署方修改姓名，僅對模板簽名生效，預設false true-允許簽署人修改姓名 false-不允許簽署人修改姓名
tspScope		array	false	信封級 TSP 範圍，預設為 false。指定後，在新增簽署人時，需從指定範圍內選擇簽署人需要使用的 TSP。列舉值包括： 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。
expireAfterSeconds		long	false	信封過期時間：超過多少秒後信封過期過期範圍：86,400 秒（1 天）~7,776,000 秒（90 天）。
redirectUrl		string	false	簽署完成重定向地址（長度 2048），需為有效的 http 地址
callBackUrl		string	false	回調地址（長度 500），需符合 https/http 協定地址

請求範例

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

回應參數

參數名稱

類型

說明

envelopeId

string

信封 ID

envelopeStatus

int

信封狀態

0-已建立（草稿）

1-簽署中

2-已完成

3-已過期

5-已撤銷

響應示例

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}