创建信封

POST /esignglobal/v1/envelope/create

接口描述

创建草稿状态的信封。

请求参数

参数名称		类型	是否必填	说明
subject		string	true	信封主题，示例：“Offer Letter”
remark		string	false	信封备注，长度限制 1000字度
signerSettings		object	false	允许签署人进行的操作
	allowTransfer	boolean	false	是否允许签署人将该信封转交给其他人签署，默认false true-允许信封中的签署人拥有信封转交他人的权力； false-不允许信封中的签署人拥有信封转交他人的权力；
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"
}