Tạo phong bì

POST /esignglobal/v1/envelope/create

Mô tả giao diện

Tạo phong bì ở trạng thái bản nháp.

Tham số yêu cầu

Tên tham số		Loại	Bắt buộc	Mô tả
subject		string	true	Chủ đề phong bì, ví dụ: “Offer Letter”
remark		string	false	Ghi chú phong bì, giới hạn độ dài 1000 ký tự
signerSettings		object	false	Các thao tác được phép cho người ký
	allowTransfer	boolean	false	Có cho phép người ký chuyển phong bì này cho người khác ký không, mặc định là false true-Cho phép người ký trong phong bì có quyền chuyển phong bì cho người khác; false-Không cho phép người ký trong phong bì có quyền chuyển phong bì cho người khác;
	allowModifyName	boolean	false	Có cho phép bên ký sửa đổi tên không, chỉ có hiệu lực đối với chữ ký mẫu, mặc định là false true-Cho phép người ký sửa đổi tên false- Không cho phép người ký sửa đổi tên
expireAfterSeconds		long	false	Thời gian hết hạn phong bì: Phong bì sẽ hết hạn sau bao nhiêu giây Phạm vi hết hạn: 86.400 giây (1 ngày) ~ 7.776.000 giây (90 ngày).
redirectUrl		string	false	Địa chỉ chuyển hướng sau khi ký hoàn tất (độ dài 2048), phải là địa chỉ http hợp lệ
callBackUrl		string	false	Địa chỉ callback (độ dài 500), phải tuân thủ địa chỉ giao thức https / http

Ví dụ yêu cầu

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Tham số phản hồi

Tên tham số

Loại

Mô tả

envelopeId

string

ID phong bì

envelopeStatus

int

Trạng thái phong bì

0 - Đã tạo (bản nháp)

1 - Đang ký

2 - Đã hoàn thành

3-Đã hết hạn

5-Đã thu hồi

Ví dụ phản hồi

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