合同催办

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

指定需要批量催办的签署流程Id，批量催办合同，最多100个; 接口失败后返回错误信息注意: 该接口不可直接调用，请联系客户经理申请使用仅能催办当前状态为“待签署”的签署人，且只能催办一次发起合同时，签署人的NotifyType需设置为sms，否则无法催办

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFlowReminds。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Operator	是	UserInfo	调用方用户信息，userId 必填
FlowIds.N	是	Array of String	需要执行催办的签署流程id数组，最多100个

3. 输出参数

参数名称	类型	描述
RemindFlowRecords	Array of RemindFlowRecords	催办合同详情列表
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 合同催办

对合同中尚未完成的用户推送催办

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowReminds
<公共请求参数>

{
    "Operator": {
        "UserId": "xxx"
    },
    "FlowIds": [
        "xxx"
    ]
}

输出示例

{
    "Response": {
        "RemindFlowRecords": [
            {
                "CanRemind": true,
                "FlowId": "xxx",
                "RemindMessage": "签署人 xxx: 此签署人已催办过；"
            }
        ],
        "RequestId": "s1675154686215203499"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.System	系统错误，请稍后重试。
InvalidParameterValue	参数取值错误。
MissingParameter.FlowId	缺少签署流程id，请检查修改后重试。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 合同催办​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​