获取签署流程列表

更新时间：2022-03-29 19:56:01

接口描述

获取当前appId对应的企业主体下，已经完成（流程完结）的签署流程列表以及签署流程的相关信息。

注：该接口支持查询企业主体下签署完成的流程

（1）通过接口发起的签署流程，仅支持获取已归档的签署流程信息；

（2）通过e签宝官网发起的签署流程，仅支持获取合同状态为已完成的合同信息。

接口发起的签署流程“归档”后，在e签宝官网显示的状态为“已完成”。

接口地址

/v2/open/processes/list

请求方式

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

请求参数

参数名称	类型	必选	参数类型	参数说明
flowStatus	int	是	query	签署流程状态。固定值：2 -已完成（流程完结）注：仅限查询完结状态下的流程，签署中的流程无法查询。
flowTimeFrom	int	是	query	查询已签署的流程（开始时间），毫秒级时间戳
flowTimeTo	int	是	query	查询已签署的流程（截止时间），毫秒级时间戳
pageNo	int	是	query	分页页码，最小为1
pageSize	int	是	query	每页数量，默认20，最大100

公共响应参数

参数名称	类型	必选	参数说明
code	int	是	业务码，0表示成功
message	string	否	信息
data	object	否	业务信息

响应参数

展开全部参数参数名称			类型	必选	参数说明
total			int	否	查询的列表总数
processInfos			array	否	签署流程列表信息
	businessScene		string	否	签署文件主题
	processId		string	否	流程ID（可忽略）
	flowId		string	否	签署流程ID
	flowStartTime		int64	否	签署流程开始时间（时间戳格式）
	flowEndTime		int64	否	签署流程完结时间（时间戳格式）
	flowStatus		int	否	签署流程状态，其他状态暂不支持 2-已完成（流程完结）
	initiator		object	否	发起方账号
		authorizedName	string	否	发起方账号名称
participantInfos		array	否	参与签署操作的账号列表信息
	authorizedName	string	否	签署方账号名称
	operatorName	string	否	参与人姓名
	operatorMobile	string	否	参与人手机号
	operatorEmail	string	否	参与人邮箱
	taskType	int	否	操作类型 2-签署任务
	taskStatus	int	否	操作状态 6-签署完成
	order	int	否	参与人操作顺序

请求示例

GET https://openapi.esign.cn/v2/open/processes/list?flowStatus=2&flowTimeFrom=1602827452000&flowTimeTo=1602834652000&pageNo=1&pageSize=20

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "total": 1,
        "processInfos": [
            {
                "processId": "af8b2a8cc9xxx5aa7825850",
                "businessScene": "xx电子印章平台签署",
                "flowId": "4994181193b9409e9xxfc",
                "flowStartTime": 1602834081000,
                "flowEndTime": 1602834341274,
                "flowStatus": 2,
                "flowStatusDesc": "完成",
                "initiator": {
                    "authorizedName": "esigntestxx测试"
                },
                "participantInfos": [
                    {
                        "authorizedName": "xxx",
                        "operatorName": "xxx",
                        "operatorMobile": null,
                        "operatorEmail": null,
                        "taskType": 2,
                        "taskStatus": 6,
                        "order": 1
                    }
                ]
            }        ]
    }
}