合同催办
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息 注意: 该接口不可直接调用,请联系客户经理申请使用 仅能催办当前状态为“待签署”的签署人,且只能催办一次
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowReminds。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
FlowIds.N | 是 | Array of String | 签署流程Id数组,最多100个,超过100不处理 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RemindFlowRecords | Array of RemindFlowRecords | 合同催办详情信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 合同催办
对合同中尚未完成的用户推送催办
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateFlowReminds
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "00498cc***********3aff766cac"
},
"AppId": "id",
"ProxyOrganizationOpenId": "d7c13a8***********0ee248f04"
},
"FlowIds": [
"y******************************m"
]
}
输出示例
{
"Response": {
"RemindFlowRecords": [
{
"CanRemind": true,
"FlowId": "y******************************m",
"RemindMessage": "签署人 xxx: 此签署人已催办过;"
}
],
"RequestId": "s167xxxx8x4184252"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |