查詢信封詳情

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-已過期 4-已拒簽 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			int	簽署人簽署順序，最小為1。
	digitalSignature			boolean	是否開啟數位簽名，預設false true-開啟，false-不開啟
	authConfig			object	校驗方式
		accessCode		object	訪問口令
			accessCode	string	訪問口令
			promptInfo	string	訪問口令提示訊息
		sms		object	簡訊OTP驗證
			countryCode	string	國家地區的國際碼
			number	string	身分認證手機號碼
		idVerification		object	身分驗證
			name	string	簽署人身分證件上的姓名全稱
		emailAuth		object	信箱OTP驗證
			authEmail	string	簽署人身分驗證信箱地址
		digitalId		object	電子身分驗證
			authApp	string	電子身分驗證使用的APP
			idNumber	string	簽署人待驗證的身分證件號碼
		whatsappAuth		object	WhatsApp OTP驗證
			countryCode	string	國家地區的國際碼
			number	string	身份認證手機號
	signerStatus			int	簽署人狀態 0-待簽署 1-簽署中 2-已簽署
	signDate			timestamp	簽署時間
	declinedReason			string	拒簽原因，當envelopeStatus為已拒簽時顯示
canceledReason				string	撤銷原因，當envelopeStatus為已撤銷時顯示

響應示例

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "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"
}