签署流程查询

更新时间：2022-10-28 17:07:15

接口描述

查询签署流程的详细信息，包括流程配置、签署状态等。

API在线调试

可通过API在线调试工具使用接口功能，入口：签署流程查询

接口

/v1/signflows/{flowId}

请求方式

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	否	业务数据
	flowId		string	否	流程ID
	appId		string	否	发起签署流程的应用ID
	businessScene		string	否	签署主题
	autoArchive		boolean	否	全部签章后流程是否自动完结
	flowStatus		int32	否	流程当前状态 0 - 草稿 1 - 签署中 2 - 已完成 3 - 已撤销 4 - 终止（签署流程设置了文件有效截至日期，到期后触发） 5 - 已过期（签署截至日期到期后触发） 7 - 已拒签 12 - 已解约
	flowDesc		string	否	流程描述如果流程已拒签或已撤回, 并且存在拒签或撤回原因,，流程描述显示为原因, 否则默认为流程状态描述
	flowStartTime		int64	否	流程开始时间（unix毫秒时间戳）
	flowEndTime		int64	否	流程结束时间（unix毫秒时间戳）
	initiatorAccountId		string	否	发起人账号ID
	initiatorAuthorizedAccountId		string	否	发起方主体账号ID
	signValidity		int64	否	签署有效截止日期
	contractValidity		int	否	文件有效截止日期
	contractRemind		int	否	文件到期前，提醒续签时间，单位小时
	configInfo		object	否	流程配置信息
		signPlatform	string	否	签署平台，逗号分割， 1 - 开放服务H5 2 - 支付宝
		noticeDeveloperUrl	string	否	回调通知接收地址
		noticeType	string	否	通知方式 1-短信 2-邮件 3-支付宝
		redirectUrl	string	否	签署完成重定向地址
		archiveLock	string	否	预留字段（开发者可忽略）
	processId		string	否	预留字段（开发者可忽略）
contractNo		string	否	预留字段（开发者可忽略）
initiatorClient		string	否	默认 OPEN_SERVICE（开发者可忽略）
appName		string	否	预留字段（开发者可忽略）
payerAccountId		string	否	预留字段（开发者可忽略）
contractEffective		string	否	预留字段（开发者可忽略）

请求示例

GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "processId": "3bfaeebd***cd42",
        "contractNo": null,
        "flowId": "2f425e***b6d9306",
        "appId": "743***1007",
        "appName": null,
        "autoArchive": false,
        "flowStatus": 1,
        "flowDesc": "签署中",
        "flowStartTime": 1646302331000,
        "flowEndTime": null,
        "businessScene": "xx合同签署",
        "initiatorClient": "OPEN_SERVICE",
        "initiatorAccountId": "55d29d5ab***f7149afe67",
        "initiatorAuthorizedAccountId": "55d29d5ab***f7149afe67",
        "payerAccountId": "55d29d5ab***149afe67",
        "signValidity": 1665479311000,
        "contractValidity": 1665479311000,
        "contractEffective": null,
        "contractRemind": 360,
        "configInfo": {
            "signPlatform": "1,2",
            "noticeType": "1",
            "noticeDeveloperUrl": "",
            "redirectUrl": null,
            "archiveLock": false
        }
    }
}