查询签署区

文档变更

2022年时，查询签署区列表变为查询签署区，以便开发者更容易理解，仅中文名称变更，其功能保持不变。无特殊说明时，文档其他地方及参数中的【签署区】字样等同于【签章区】。

接口描述

查询签署流程中签署区信息，签署区信息大致包含坐标位置、印章ID、签章状态等信息。

常见使用场景如下：

（1）需要查询签署流程中所有的签署区信息。

（2）需要查询签署流程中某个签署方所涉及的全部签署区信息。

接口地址&请求方式

接口地址：/v1/signflows/{flowId}/signfields

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称	类型	必选	参数类型	参数说明（左右拖动查看完整描述）
flowId	string	是	path	签署流程ID
accountId	string	否	query	账号id，默认所有签署人
signfieldIds	string	否	query	指定签署区ID列表，逗号分割，默认所有签署区

响应参数

展开全部参数参数名称				类型	必选	参数说明（左右拖动查看完整描述）
code				int	是	业务码，0表示成功
message				string	否	业务信息
data				object	否	业务数据
	signfields			array	否	签署区列表数据
	actorIndentityType		int	否	签约主体类别，0-个人，2-机构
	addTime		int	否	签署区添加时间
	assignedPosbean		boolean	否	是否指定位置，无默认值 true - 表示不允许更新位置，配置项
	assignedSeal		boolean	否	是否指定印章数据，无默认值 true - 表示不允许更新印章，配置项
	authorizedAccountId		string	否	签约主体账号标识，将使用该主体账号对应的数字证书完成本次签署。如：当存在签署操作人代某机构签署时，需要传入该机构的账号id
	autoExecute		boolean	否	是否自动执行，TRUE需要静默授权，配置项，无默认值
	executeFailedReason		string	否	执行失败原因
	fileId		string	否	文件fileId
	flowId		string	否	签署流程ID
	order		int	否	签署区顺序，默认1,且不小于1，顺序越小越先处理
	posBean		object	否	签署区位置信息
		posPage	string	否	页码信息，可以','或'-'分割
		posX	float	否	x坐标
		posY	float	否	y坐标
		width	float	否	签署区宽
	sealFileKey		string	否	印章文件file key
	sealId		string	否	印章id
	sealType		string	否	印章类型，支持多种类型时逗号分割，0-手绘印章，1-模版印章，为空不限制
	signType		int	否	签署类型，0-不限，1-单页签署，2-骑缝签署,4-关键字签署，默认1
	signerAccountId		string	否	签署操作人个人账号标识，即操作本次签署的个人，如需e签宝通知用户签署，则系统向该账号下绑定的手机、邮箱发送签署链接
	signfieldId		string	否	签署区ID
status		int	否	签署区状态 0 - 等待执行 1 - 执行中 2 - 执行失败 3 - 审批中 4 - 执行完成
updateTime		int	否	签署区签署时间，Unix时间戳（毫秒级）当status=0时，updataTime为签署区创建时间；当status=1时，updataTime为签署区创建时间；当status=2时，updataTime为执行失败的时间；当status=3时，updataTime为审批提交时间；当status=4时，updataTime为签署区签署时间；
statusDescription		string	否	状态描述
thirdOrderNo		string	否	发起签署时指定的第三方业务流水号，用于标识自己的业务及签署方。

请求示例

GET https://openapi.esign.cn/v1/signflows/a017ba10bc3b4af197d63941ab4a7838/signfields

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signfields": [
            {
                "signfieldId": "a01c3f4e8bce4c83bc15453234a18d82",
                "flowId": "a017ba10bc3b4af197d63941ab4a7838",
                "signerAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "authorizedAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "fileId": "2ef2c7001a094256a9d14a6d661612f2",
                "status": 4,
                "statusDescription": "执行完成",
                "executeFailedReason": null,
                "addTime": 1632900988224,
                "sealType": "",
                "signType": 1,
                "order": 1,
                "autoExecute": false,
                "thirdOrderNo": "N001-15300001111",
                "assignedPosbean": true,
                "assignedSeal": false,
                "addSignTime": false,
                "actorIndentityType": 0,
                "sealId": "8d451107-0d91-4975-945c-5adb4b6bdfd5",
                "sealFileKey": "",
                "posBean": {
                    "posPage": "1",
                    "posX": 120.0,
                    "posY": 256.0,
                    "width": 95.0
                },
                "updateTime": 1632901017000
            },
            {
                "signfieldId": "02a8486075bf496d93ae3f4fcb584f8b",
                "flowId": "a017ba10bc3b4af197d63941ab4a7838",
                "signerAccountId": "01fcaed8c1b146c3aaca1d8f0ef0a8f6",
                "authorizedAccountId": "337892a76f394b4f9fb2229e84105f0a",
                "fileId": "2ef2c7001a094256a9d14a6d661612f2",
                "status": 4,
                "statusDescription": "执行完成",
                "executeFailedReason": null,
                "addTime": 1632900988298,
                "sealType": "",
                "signType": 1,
                "order": 1,
                "autoExecute": false,
                "thirdOrderNo": "N001-esigntest啦啦啦测试企业",
                "assignedPosbean": true,
                "assignedSeal": false,
                "addSignTime": false,
                "actorIndentityType": 2,
                "sealId": "5550eb16-f9c2-4733-b1aa-0133b6ec8e74",
                "sealFileKey": "",
                "posBean": {
                    "posPage": "1",
                    "posX": 320.0,
                    "posY": 256.0,
                    "width": 159.0
                },
                "updateTime": 1632901017000
            }
        ]
    }
}