查詢信封詳情

GET /esignglobal/v1/envelope/envelopeDetail

接口描述

查詢信封的詳細信息,包括簽署進度、信封狀態等

請求參數

參數名稱	類型	必填	說明
envelopeId	string	true	信封 ID

請求示例

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

響應參數

參數名稱			類型	說明
envelopeId			string	信封 ID
envelopeStatus			int	信封狀態 0-草稿 1-簽署中 2-已完成 3-已過期 5-已撤銷
envelopeEndTime			timestamp	信封結束時間
envelopeCreateTime			timestamp	信封開始時間
subject			string	信封主題
remark			string	信封備註(長度1000)
redirectUrl			string	簽署完成重定向地址(長度500)
CCInfos			array	抄送人信息集合
	userEmail		string	抄送人郵箱地址
	userName		string	抄送人姓名
InitiatorInfo			object	發送人信息集合
	userName		string	發送人姓名,默認為開放應用APPID所屬創建人姓名
signFiles			array	簽署文件信息集合
	fileKey		string	簽署文件fileKey
attachments			array	信封附件集合
	fileKey		string	信封 fileKey
SignerInfos			array	簽署人信息
	businessId		string	開發者自定義業務編號(長度500)
	userName		string	簽署人名稱
	userEmail		string	簽署人郵箱地址
	phoneNumber		object	簽署人接收短信地址
		countryCode	string	國家地區的國際碼
		number	string	簽署人接收簽署消息手機號
	signOrder		string	簽署人簽署順序,最小為1
	digitalSignature		boolean	是否開啟數字簽名,默認false True-開啟,false-不開啟
	accessCode		string	簽署頁訪問口令
	signerStatus		int	簽署人狀態 0-待簽署 1-簽署中 2-已簽署
	signDate		timestamp	簽署時間
	canceledReason		string	撤銷原因,當envelopeStatus為已撤銷時顯示

Response Example

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