接口描述
查询流程签署区列表，可以查询指定指定id或者签署人所属的签署区
接口
/v1/signflows/{flowId}/signfields
请求方式
GET
请求头
提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
X-Tsign-Open-App-Id | string | 是 | 项目ID | |
Content-Type | string | 是 | application/json;charset=UTF-8 | |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 | |
Accept | string | 是 | 建议统一填写 */* | |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 | |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 | |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 项目ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 |
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 | 否 | 文件file id | |||
flowId | string | 否 | 流程id | |||
order | int | 否 | 签署区顺序，默认1,且不小于1，顺序越小越先处理 | |||
posBean | 否 | 签署区位置信息 | ||||
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 | 否 | 签署区签署时间。 当status=0时，updataTime为签署区创建时间； 当status=1时，updataTime为签署区创建时间； 当status=2时，updataTime为执行失败的时间； 当status=3时，updataTime为审批提交时间； 当status=4时，updataTime为签署区签署时间； | |||
statusDescription | string | 否 | 状态描述 | |||
请求示例
GET https://openapi.esign.cn/v1/signflows/b2cb74258a634179b0df3cc54791c8b6/signfields?accountId=faea8237c61a4fdea864ee8d7621e14f
响应示例
{
"code": 0,
"message": "成功",
"data": {
"signfields": [
{
"signfieldId": "b76b69d5b48d4f689cae997e42809ac4",
"flowId": "b2cb74258a634179b0df3cc54791c8b6",
"signerAccountId": "faea8237c61a4fdea864ee8d7621e14f",
"authorizedAccountId": "2c7de24aff3340f5b944ebac49545b8e",
"fileId": "fe7df2f477d649c18ebcfdfffeba253d",
"status": 1,
"statusDescription": "执行中",
"executeFailedReason": null,
"addTime": 1561473111450,
"sealType": "",
"signType": 0,
"order": 1,
"autoExecute": false,
"assignedPosbean": false,
"assignedSeal": false,
"addSignTime": false,
"actorIndentityType": 1,
"sealId": "",
"sealFileKey": "",
"posBean": {
"posPage": "1",
"posX": 158.72531,
"posY": 431.05658
},
"updateTime": 1606186015103
}
]
}
}错误码
错误码 | 错误描述 | 解决方案 |
我要纠错