創建信封

POST /esignglobal/v1/envelope/create

接口描述

創建草稿狀態的信封。

請求參數

參數名稱

類型

是否必填

説明

subject

string

true

信封主題,示例:“Offer Letter”

remark

string

false

信封備註,長度限制 1000 字

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

 

接口描述
請求參數
請求示例
響應參數
響應示例