查询签署流程

更新时间：2022-10-28 17:08:37

文档变更

2022年时，签署流程查询变为查询签署流程，以便开发者更容易理解，仅中文名称变更，其功能保持不变。

接口描述

可用于查询某个签署流程的基本信息，如签署流程当前状态、通知方式等。

接口地址&请求方式

接口地址： /v1/signflows/{flowId}

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称

类型

必选

参数类型

参数说明

（左右拖动查看完整描述）

flowId

string

是

path

签署流程ID

响应参数

展开全部参数参数名称			类型	必选	参数说明（左右拖动查看完整描述）
code			int	是	业务码，0表示成功
message			string	否	业务信息
data			object	否	业务数据
	appId		string	否	发起签署流程的应用ID
	autoArchive		boolean	否	全部签章后流程自动完结
	businessScene		string	否	文件主题
	configInfo		object	否	流程配置信息
		noticeDeveloperUrl	string	否	通知开发者地址
		noticeType	string	否	通知方式，英文逗号分割 1-短信 2-邮件 3-支付宝 4-钉钉
		redirectUrl	string	否	签署完成重定向地址
		signPlatform	string	否	签署平台，逗号分割， 1-开放服务H5， 2-支付宝
	contractValidity		int	否	文件有效截止日期
	contractRemind		int	否	文件到期前，提前多少小时提醒续签
	flowId		string	否	流程Id
	flowStartTime		string	否	流程开始时间
	flowEndTime		string	否	流程结束时间
	flowStatus		int	否	流程状态, 0-草稿 1-签署中 2-完成 3-撤销 5-过期（签署截至日期到期后触发） 7-拒签
flowDesc		string	否	流程描述, 如果流程已拒签或已撤回, 并且存在拒签或撤回原因, 流程描述显示为原因, 否则默认为流程状态描述
initiatorAccountId		string	否	发起人账户id
initiatorAuthorizedAccountId		string	否	发起方主体id
signValidity		int	否	签署有效截止日期

请求示例

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

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "appId":"1111563841",
        "autoArchive":false,
        "businessScene":"合同名称",
        "configInfo":{
            "signPlatform":"1",
            "noticeType":"1,2",
            "noticeDeveloperUrl":"http://127.0.0.1:9110/notice",
            "redirectUrl":"http://127.0.0.1:8110/h5/forword"
        },
        "flowId":"429b1d3038854cabbcdac0a63d7e4c0d",
        "flowStatus":2,
        "flowDesc":"完成",
        "flowStartTime":1560764486000,
        "flowEndTime":1561764486000,
        "initiatorAccountId":"40eb61714d9e49088bac7a3c56d69d66",
        "initiatorAuthorizedAccountId":"40eb61714d9e49088bac7a3c56d69d66",
        "signValidity":1592386042000,
        "contractValidity":1592386042000,
        "contractRemind":360
    }
}