Truy vấn chi tiết phong bì

GET /esignglobal/v1/envelope/envelopeDetail

Mô tả giao diện

Truy vấn thông tin chi tiết của phong bì, bao gồm tiến độ ký, trạng thái phong bì, v.v.

Tham số yêu cầu

Tên tham số	Loại	Bắt buộc	Mô tả
envelopeId	string	true	ID phong bì

Ví dụ yêu cầu

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

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 4-Đã từ chối ký 5-Đã hủy
envelopeEndTime			timestamp	Thời gian kết thúc phong bì
envelopeCreateTime			timestamp	Thời gian bắt đầu phong bì
subject			string	Chủ đề phong bì
remark			string	Ghi chú phong bì (độ dài 1000)
redirectUrl			string	Địa chỉ chuyển hướng sau khi ký hoàn tất (độ dài 500)
CCInfos			array	Tập hợp thông tin người nhận CC
	userEmail		string	Địa chỉ email người nhận CC
	userName		string	Tên người nhận bản sao
initiatorInfo			object	Tập hợp thông tin người gửi
	userName		string	Tên người gửi, mặc định là tên người tạo thuộc APPID của ứng dụng mở
signFiles			array	Tập hợp thông tin tệp tin ký
	fileKey		string	fileKey của tệp tin ký
attachments			array	Tập hợp tệp tin đính kèm phong bì
	fileKey		string	fileKey phong bì
signerInfos			array	Thông tin người ký
	businessId		string	Số nghiệp vụ tùy chỉnh của nhà phát triển, (độ dài 500)
	userName		string	Tên người ký
	userEmail		string	Địa chỉ email của người ký
	phoneNumber		object	Địa chỉ SMS mà người ký nhận
		countryCode	string	Mã quốc tế của quốc gia/khu vực
		number	string	Số điện thoại di động của người ký để nhận tin nhắn ký
	signOrder		int	Thứ tự ký của người ký, tối thiểu là 1.
	digitalSignature		boolean	Có bật chữ ký số hay không, mặc định là false true-Bật, false-Không bật
	accessCode		string	Mật khẩu truy cập trang ký
	signerStatus		int	Trạng thái người ký 0-Chờ ký 1-Đang ký 2-Đã ký
	signDate		timestamp	Thời gian ký
	declinedReason		string	Lý do từ chối ký, hiển thị khi envelopeStatus là đã từ chối ký
canceledReason			string	Lý do hủy, hiển thị khi envelopeStatus là đã hủy

Ví dụ phản hồi

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}