查询合同(签署流程)的详细信息
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeFlowDetailInfo。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
FlowIds.N | 否 | Array of String | 合同(流程)编号数组,最多支持100个。 备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参 |
FlowGroupId | 否 | String | 合同组编号 备注:该参数和合同(流程)编号数组必须二选一 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ApplicationId | String | 第三方平台应用号Id |
ProxyOrganizationOpenId | String | 第三方平台子客企业OpenId |
FlowInfo | Array of FlowDetailInfo | 合同(签署流程)的具体详细描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
FlowGroupId | String | 合同组编号 注意:此字段可能返回 null,表示取不到有效值。 |
FlowGroupName | String | 合同组名称 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询签署流程合同的详细信息
查询签署流程合同的详细信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowDetailInfo
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "子客企业经办人id"
},
"ProxyOrganizationOpenId": "子客企业第三方id",
"AppId": "16fd2f7d7xxxxx5f8d501d57b5ec"
},
"FlowIds": [
"yDxjGUUgydjxxxxxzjERvGKmZJeX"
]
}
输出示例
{
"Response": {
"ApplicationId": "yDwcC******ciRHST9jtYB",
"FlowGroupId": "",
"FlowGroupName": "",
"FlowInfo": [
{
"CcInfos": [],
"CreateOn": 1686120086,
"CustomData": "",
"DeadLine": 1717656086,
"FlowApproverInfos": [
{
"ApproveMessage": "",
"ApproveName": "张三",
"ApproveStatus": "PENDING",
"ApproveTime": 0,
"ApproveType": "PERSON",
"Mobile": "133*****75",
"ProxyOperatorOpenId": "oHeIG5gF****TXeXZrb4",
"ProxyOrganizationName": "",
"ProxyOrganizationOpenId": "",
"ReceiptId": "yDwg4UUc****QEAn6BWc39jZVY",
"SignOrder": 0
}
],
"FlowId": "yDwg4UUc******6CLBKPEvnl",
"FlowMessage": "",
"FlowName": "电子合同",
"FlowStatus": "INIT",
"FlowType": "",
"NeedCreateReview": false
}
],
"ProxyOrganizationOpenId": "t1td99d*****d28ec280dd4",
"RequestId": "c1f80560-****-ae0be7462559"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.System | 系统错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.EndPoint | 不合法的EndPoint,请检查修改后重试。 |
InvalidParameter.FlowIds | 参数错误,合同id列表长度非法,请检查后重试。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.fFowIds | 流程id不存在。 |
LimitExceeded.FlowIds | 合同id数超出限制。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.FlowIds | 缺少流程id,请检查后重试。 |
MissingParameter.FlowIdsOrFlowGroupId | 请传入需要查询的合同或合同组的ID。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserNotInOrganization | 用户不归属于当前企业,无法操作,请检查后重试。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.FlowApprovers | 签署人信息不存在,请检查后重试。 |
ResourceNotFound.FlowGroup | 合同组不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |