查询签署流程列表

更新时间:2024-01-16 11:39:43

接口描述

  • 支持查询指定时间段内,接口发起的全部签署流程列表信息。
  • 支持指定签署流程的具体状态,查询状态对应时间段内的全部签署流程列表。
  • 支持指定发起方,查询其名下对应时间段内的全部签署流程列表。
  • 支持指定签署人以及签署人的签署状态,查询其名下对应时间段内的全部签署流程列表。

注意事项:

仅能查询当前应用Id(appId)通过接口发起的签署流程列表。

接口地址&请求方法

接口地址:https://{host}/v3/sign-flow/sign-flow-list

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式。

请求参数

展开全部参数参数名称

参数类型

必选

参数位置

参数说明

pageNum

int32

是

body

查询页码(大于0,最小值为1)

pageSize

int32

是

body

每页显示的数量(可选范围[1~100])

signFlowStartTimeFrom

int64

否

body

开始时间(发起签署流程时间),Unix时间戳(毫秒级)格式

【注】

  • 开始时间到结束时间的时间范围最长不可超过1年,且只能查询近5年的流程
  • 发起签署流程的时间区间和完结签署流程的时间区间不可同时为空

signFlowStartTimeTo

int64

否

body

结束时间(发起签署流程时间),Unix时间戳(毫秒级)格式

signFlowFinishTimeFrom

int64

否

body

开始时间(完结签署流程时间),Unix时间戳(毫秒级)格式

【注】

  • 开始时间到结束时间的时间范围最长不可超过1年,且只能查询近5年的流程
  • 发起签署流程的时间区间和完结签署流程的时间区间不可同时为空
  • 根据流程完结的时间区间查询到的signFlowStatus(流程状态)一定是:2 - 已完成

signFlowFinishTimeTo

int64

否

body

结束时间(完结签署流程时间),Unix时间戳(毫秒级)格式

signFlowStatus

list

否

body

流程状态,默认为全部状态

  • 1 - 签署中
  • 2 - 已完成
  • 3 - 撤销
  • 5 - 过期(签署截至日期到期后触发)
  • 7 - 拒签

initiator

object

否

body

签署流程的发起方

【注】个人发起方和机构发起方不能同时传入


initiatorOrgId

string

否

body

机构发起方账号ID

transactorPsnId

string

否

body

机构发起方经办人账号ID

【注】若传initiatorOrgId,此参数非必传;但若传此参数,initiatorOrgId必传。

initiatorPsnId

string

否

body

个人发起方账号ID

operator(点击“+”展开详情)

object

否

body

签署操作人(个人签署方本人为操作人,机构签署方经办人为操作人)

【注】psnId 与 psnAccount 二选一传入即可。


psnAccount

string

否

body

个人签署方账号标识(手机号)

psnId

string

否

body

个人签署方ID

organization(点击“+”展开详情)

object

否

body

机构签署方信息

【注】orgId 与 orgName 二选一传入即可。

orgId

string

否

body

机构签署方ID

orgName

string

否

body

机构签署方名称

signStatus

list

否

body

签署人的签署状态,默认为全部状态

0 - 等待签署

1 - 签署中

2 - 已签署

3 - 等待审批

4 - 已拒签

【注】查此状态,必须传入operator(签署操作人信息)

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

是

业务码,0表示成功,非0表示异常。

message

string

否

业务信息

请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

否

业务数据

total

int32

否

查询结果中流程的总数量

signFlowInfos(点击“+”展开详情)

array

否

签署流程列表信息

signFlowId

string

否

签署流程ID

signFlowStartTime

int64

否

流程开始时间(unix时间戳毫秒格式)

signFlowEndTime

int64

否

流程结束时间(unix时间戳毫秒格式)

signFlowTitle

string

否

签署流程标题

signFlowStatus

int32

否

签署流程状态

0 - 草稿

1 - 签署中

2 - 完成

3 - 撤销

5 - 过期(签署截至日期到期后触发)

7 - 拒签

点击这里了解更多流程状态说明。

rescissionStatus

int32

否

签署流程的解约状态

0 - 未解约

1 - 解约中

2 - 部分解约

3 - 已解约

signFlowInitiator(点击“+”展开详情)

object

否

签署流程发起方信息

psnInitiator

object

否

个人发起方信息

psnAccount

object

否

个人账号

accountMobile

string

否

手机号(个人账号标识)

accountEmail

string

否

邮箱号(个人账号标识)

psnId

string

否

个人账号ID

orgInitiator

object

否

机构发起方信息

orgId

string

否

机构账号ID

orgName

string

否

机构名称(机构账号标识)

transactor

object

否

机构方经办人

psnAccount

object

否

经办人账号

accountMobile

string

否

手机号(经办人账号标识)

accountEmail

string

否

邮箱号(经办人账号标识)

psnId

string

否

经办人账号ID

signers(点击“+”展开详情)

array

否

签署方信息列表

signOrder

int32

否

签署顺序

顺序值 1-255 ,不同参与人可重复

signStatus

int32

否

签署人的签署状态

0 - 等待签署

1 - 签署中

2 - 已签署

3 - 等待审批

4 - 已拒签

psnSigner

object

否

个人签署方

psnId

string

否

个人签署方账号ID

psnAccount

object

否

个人签署方账号

accountMobile

string

否

手机号(个人账号标识)

accountEmail

string

否

邮箱号(个人账号标识)

orgSigner

object

否

机构签署方

orgId

string

否

机构账号ID

orgName

string

否

机构名称(机构账号标识)

transactor

object

否

机构签署经办人

psnAccount

object

否

经办人账号

accountMobile

string

否

手机号(经办人账号标识)

accountEmail

string

否

邮箱号(经办人账号标识)

psnId

string

否

经办人账号ID

请求示例

{
	"operator": {
		"psnAccount": "183****0101",
		"psnId": ""
	},
	"pageNum": 1,
	"pageSize": 20,
	"signFlowStartTimeFrom": 1648801671000,
	"signFlowStartTimeTo": 1651393671000,
	"signFlowStatus": [1,2]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "total": 1,
        "signFlowInfos": [
            {
                "signFlowInitiator": {
                    "psnInitiator": null,
                    "orgInitiator": {
                        "orgId": "55d29d5ab***7149afe67",
                        "orgName": "xxx企业",
                        "transactor": null
                    }
                },
                "signers": [
                    {
                        "psnSigner": {
                            "psnId": "c7e00294729***ea310541e7",
                            "psnAccount": {
                                "accountMobile": "183****0101",
                                "accountEmail": null
                            }
                        },
                        "orgSigner": null
                    }
                ],
                "signFlowId": "a9084f284***b4478ad0",
                "signFlowStartTime": 1649409511000,
                "signFlowEndTime": null,
                "signFlowStatus": 1,
                "rescissionStatus": 0,
                "signFlowTitle": "xx企业劳动合同签署"
            }
        ]
    }
}

错误码

点击查看错误码