签署流程查询
接口地址 /v1/signflows/{flowId}
请求方式 GET
接口描述 查询签署流程的详细信息，包括流程配置、签署状态等。
请求参数
| 参数名称 | 说明 | 参数类型 | 必填 | 类型 |
|---|---|---|---|---|
| flowId | 流程id | path | TRUE | string |
请求示例
GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d
响应参数
| 参数名称 | 说明 | 类型 | |
|---|---|---|---|
| appId | 发起签署流程的应用Id | string | |
| autoArchive | 是否自动归档 | boolean | |
| businessScene | 文件主题 | string | |
| configInfo | 流程配置信息 | object | |
| noticeDeveloperUrl | 通知开发者地址 | string | |
| noticeType | 通知方式，逗号分割，1-短信 2-邮件 3-支付宝 4-钉钉 | string | |
| redirectUrl | 签署完成重定向地址 | string | |
| signPlatform | 签署平台，逗号分割， 1-开放服务h5， | string | |
| contractValidity | 文件有效截止日期 | int64 | |
| contractRemind | 文件到期前，提前多少小时提醒续签 | int32 | |
| flowId | 流程Id | string | |
| flowStartTime | 流程开始时间 | string | |
| flowEndTime | 流程结束时间 | string | |
| flowStatus | 流程状态,0-草稿 1-签署中 2-完成 3-撤销 4-终止 5-过期 6-删除 7-拒签 | int32 | |
| flowDesc | 流程描述, 如果流程已拒签或已撤回, 并且存在拒签或撤回原因, 流程描述显示为原因, 否则默认为流程状态描述 | ||
| initiatorAccountId | 发起人账户id | string | |
| initiatorAuthorizedAccountId | 发起方主体id | string | |
| signValidity | 签署有效截止日期 | string |
响应示例
{
"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
}
}
错误码
| 错误码 | 错误信息 | 错误原因 |
|---|---|---|