创建信封

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

 

接口描述
请求参数
请求示例
响应参数
响应示例