查询签署区（按手机&邮箱）

接口描述

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

常见使用场景如下：

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

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

【重要提示】

区别于通过签署方账号ID方式发起的签署流程，本接口适用于查询通过账号（手机号/邮箱）发起的签署区信息。

注意：

本接口的请求参数

signFlowId即为【发起签署流程（按手机&邮箱）】接口创建成功返回的flowId流程ID。

本接口响应参数中

operatorAccount对应【发起签署流程（按手机&邮箱）】参数signerAccount签署人账号（手机号/邮箱）、

signerAccount对应参数authorizedAccount签约主体账号信息（个人手机号/邮箱/机构名称）、

autoExecuteSign对应参数autoInitiate是否自动执行、

assignedSignPosition对应参数assignedPosbean是否固定位置签署、

signPositionType对应signType签署类型（0-不限，1-单页签署，2-骑缝签署）、

signFieldPositionInfo对应参数posBean签署区位置信息：

positionPage对应参数posPage页面信息、positionX对应参数posX（x坐标）、positionY对应参数posY（y坐标）、signFieldWidth对应参数width签署区宽度。

接口地址&请求方式

接口地址：/v3/sign-flow/{signFlowId}/sign-fields

请求方式：POST

请求头格式

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

请求参数

参数名称	类型	必选	参数类型	参数说明
signFlowId	string	是	path	签署流程ID
operatorAccount	string	否	body	签署操作人账号（手机号/邮箱）
operatorId	string	否	body	签署操作人账号ID
signerAccount	string	否	body	签署主体账号（手机号/邮箱/企业名称）
signerId	string	否	body	签署主体账号ID
signfieldIds	string	否	body	指定签署区ID列表，逗号分割，默认所有签署区

响应参数

展开全部参数参数名称				类型	必选	参数说明（左右拖动查看完整描述）
code				int	是	业务码，0表示成功
message				string	是	业务信息
data				object	否	业务数据
	signFields			array	否	签署区列表数据
	fileId		string	否	文件ID
	signFlowId		string	否	签署流程ID
	signFieldId		string	否	签署区ID
	signerType		int	否	签约主体类别，0-个人，2-机构
	signerId		string	否	签约主体的账号id（个人/企业）；如签署人本签署，则返回签署人账号id；如签署人代机构签署，则返回机构账号id；
	signerAccount		object	否	签约主体账号信息
		mobile	string	否	手机号
		email	string	否	邮箱
		orgName	string	否	企业/机构名称
	operatorId		string	否	签署操作人个人账号ID
	operatorAccount		object	否	签署操作人账号信息
		mobile	string	否	手机号
		email	string	否	邮箱
		orgName	string	否	机构名称
	assignedSeal		boolean	否	是否指定印章数据
	autoExecuteSign		boolean	否	是否自动执行
	assignedSignPosition		boolean	否	签署区位置是否固定
	signFieldOrder		int	否	签署区顺序
	signFieldType		int	否	签署区类型，0 -签章签署区，2 -备注签署区
	signFieldPositionInfo		object	否	签署区位置信息
		positionPage	string	否	页码信息
		positionX	float	否	x坐标
		positionY	float	否	y坐标
signFieldWidth		float	否	签署区宽度
signFieldHeight		float	否	签署区高度
signPositionType		int	否	签署类型，0-不限，1-单页签署，2-骑缝签署
sealFileKey		string	否	印章文件file key
sealId		string	否	印章ID
sealStyle		string	否	印章类型 0-手绘印章，1-模版印章
signFieldStatus		int	否	签署区状态 0 - 等待执行 1 - 执行中 2 - 执行失败 3 - 审批中 4 - 执行完成
executeFailedReason		string	否	执行失败原因
signFieldAddTime		int	否	签署区添加时间
statusUpdateTime		int	否	签署区签署时间，Unix时间戳（毫秒级）当status=0时，updataTime为签署区创建时间；当status=1时，updataTime为签署区创建时间；当status=2时，updataTime为执行失败的时间；当status=3时，updataTime为审批提交时间；当status=4时，updataTime为签署区签署时间；
statusDescription		string	否	状态描述

请求示例

{
	"signerAccount": "esigntestxx企业",
	"signerId": "0c5bd492486b47f58d4ba9xx"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signFields": [
            {
                "signerType": 2,
                "signFieldAddTime": 1644994286418,
                "assignedSignPosition": true,
                "assignedSeal": false,
                "signerId": "0c5bd492486b47f58d4ba9xx",
                "signerAccount": {
                    "mobile": null,
                    "email": null,
                    "orgName": "esigntestxx企业"
                },
                "autoExecuteSign": false,
                "executeFailedReason": null,
                "fileId": "c8b8d909bdbf4de3b6f99exx",
                "signFlowId": "0f24d2fca5b244cbbe8866baxx",
                "signFieldOrder": 1,
                "signFieldType": 0,
                "signFieldPositionInfo": {
                    "positionPage": "1",
                    "positionX": 440.0,
                    "positionY": 440.0,
                    "signFieldWidth": 150.0,
                    "signFieldHeight": null
                },
                "sealId": "",
                "sealFileKey": "",
                "sealStyle": null,
                "signPositionType": 1,
                "operatorId": "c7e0029472914ce4ab33deea3xx",
                "operatorAccount": {
                    "mobile": "183xxxx2635",
                    "email": null,
                    "orgName": null
                },
                "signFieldId": "ba7140e1381f484db33d961d6xx",
                "signFieldStatus": 1,
                "statusDescription": "执行中",
                "statusUpdateTime": 1644994286418
            }
        ]
    }
}