查询信封详情

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		int	签署人签署顺序，最小为1。
	digitalSignature		boolean	是否开启数字签名，默认false true-开启，false-不开启
	accessCode		string	签署页访问口令
	signerStatus		int	签署人状态 0-待签署 1-签署中 2-已签署
	signDate		timestamp	签署时间
	canceledReason		string	撤销原因，当envelopeStatus为已撤销时显示

响应示例

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