接口描述
查询流程所有签署人列表。
接口
/v1/signflows/{flowId}/signers
请求方式
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 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码，0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | 示例值 | |
signers | array | 否 | 签字人列表 | ||
signOrder | int | 否 | 签署顺序 | ||
signStatus | int | 否 | 签署状态, 0-待签, 1-未签, 2-已签 3-待审批 4-拒签 | ||
signerAccountId | string | 否 | 签署人账号id | ||
signerName | string | 否 | 签署人名称 | ||
signerRealName | boolean | 否 | 签署人是否已实名 | ||
signerAuthorizedAccountId | string | 否 | 签约主体的账号id（个人/企业）；如签署人本签署，则返回签署人账号id；如签署人代机构签署，则返回机构账号id | ||
signerAuthorizedAccountName | string | 否 | 签约主体名称 | ||
signerAuthorizedAccountRealName | boolean | 否 | 签署主体是否已实名 | ||
signerAuthorizedAccountType | int | 否 | 签署主体类型, 0-个人, 1-机构 | ||
thirdOrderNo | string | 否 | 本次签署任务对应指定的第三方业务流水号id，当存在多个第三方业务流水号id时，返回多个，并逗号隔开 | ||
请求示例
GET https://openapi.esign.cn/v1/signflows/{flowId}/signers响应示例
{
"code":0,
"data":{
"signers":[
{
"signOrder":1,
"signStatus":1,
"signerAccountId":"24c93459216945468fdf1d899c521910",
"signerAuthorizedAccountId":"2c7de24aff3340f5b944ebac49545b8e",
"signerAuthorizedAccountName":"深圳天谷信息科技有限公司",
"signerAuthorizedAccountRealName":true,
"signerAuthorizedAccountType":1,
"signerName":"孙中山",
"signerRealName":true
}
]
},
"message":"成功"
}错误码
错误码 | 错误描述 | 解决方案 |
1437105 | 流程已删除 | 已经删除的流程不能查看签署人列表 |
我要纠错