查询签署流程（按手机&邮箱）

更新时间：2022-05-11 17:43:39

接口描述

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

【重要提示】

区别于通过签署方账号ID方式发起的签署流程，本接口适用于查询通过账号（手机号/邮箱）发起的签署流程。

注意：

本接口的请求参数signFlowId即为【发起签署流程（按手机&邮箱）】接口创建成功返回的flowId。

本接口响应参数中

signFlowTitle对应【发起签署流程（按手机&邮箱）】的入参businessScene签署主题、

signFlowConfigInfo对应flowConfigInfo流程配置信息、

notifyUrl对应noticeDeveloperUrl 回调通知地址、

clientType对应signPlatform 签署平台。

接口地址&请求方式

接口地址： /v3/sign-flow/{signFlowId}

请求方式：GET

请求头格式

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

请求参数

参数名称	类型	必选	参数类型	参数说明
signFlowId	string	是	path	签署流程ID

响应参数

展开全部参数参数名称			类型	必选	参数说明
code			int	是	业务码，0表示成功
message			string	否	业务信息
data			object	否	业务数据
	appId		string	否	发起签署流程的应用APPID
	autoArchive		boolean	否	全部签章后流程是否自动完结
	signFlowTitle		string	否	签署主题
	signFlowConfigInfo		object	否	流程配置信息
		notifyUrl	string	否	接收e签宝回调通知地址
		noticeType	string	否	通知方式，英文逗号分割 1-短信 2-邮件
		redirectUrl	string	否	签署完成重定向地址
		clientType	string	否	签署平台，逗号分割， 1-开放服务H5，2-支付宝
	contractValidity		int	否	文件有效截止日期
	contractRemind		int	否	文件到期前，提前多少小时提醒续签
	signFlowId		string	否	流程ID
	signFlowStartTime		string	否	流程开始时间
	signFlowEndTime		string	否	流程结束时间
	signFlowStatus		int	否	流程状态, 0-草稿 1-签署中 2-完成 3-撤销 5-过期（签署截至日期到期后触发） 7-拒签
	signFlowDescription		string	否	流程描述, 如果流程已拒签或已撤回, 并且存在拒签或撤回原因, 流程描述显示为原因, 否则默认为流程状态描述
	initiatorId		string	否	发起人账号ID
initiatorAccount		object	否	发起方信息（默认应用APPID归属企业）
	mobile	string	否	手机号
	email	string	否	邮箱
	orgName	string	否	机构/企业名称
belongerId		string	否	发起方主体账号ID
belongerAccount		object	否	发起方主体信息（默认应用APPID归属企业）
	mobile	string	否	手机号
	email	string	否	邮箱
	orgName	string	否	机构/企业名称
signValidity		string	否	签署有效截止日期

请求示例

GET https://openapi.esign.cn/v3/sign-flow/429b1d3038854cabbcdac0a63d7xxx

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "appId": "743886xxx7",
        "autoArchive": true,
        "signFlowTitle": "xx劳动合同签署",
        "signFlowConfigInfo": {
            "notifyUrl": "",
            "noticeType": "1",
            "redirectUrl": null,
            "clientType": "1,2"
        },
        "contractValidity": 1672502400000,
        "contractRemind": 1,
        "signFlowId": "0f24d2fca5b244cbbe8866badxxx",
        "signFlowStartTime": 1644994287000,
        "signFlowEndTime": null,
        "signFlowStatus": 1,
        "signFlowDescription": "签署中",
        "initiatorId": "55d29d5ab5c543d98560e4f71xxx",
        "initiatorAccount": {
            "mobile": null,
            "email": null,
            "orgName": "esigntestxxx企业"
        },
        "belongerId": "55d29d5ab5c543d98560e4f71xxx7",
        "belongerAccount": {
            "mobile": null,
            "email": null,
            "orgName": "esigntestxxx企业"
        },
        "signExpireTime": 1669824000000
    }
}