合同催办

1. 接口描述

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

指定需要批量催办的签署流程ID，批量催办合同，最多100个

需要符合以下条件的合同才可被催办：

1. 发起合同时，**设置了签署人通知类型：SMS,EMAIL,ALL**
2. 合同中当前状态为 **待签署** 的签署人是催办的对象
3. **每个合同的每个签署方最多3次*

催办的规则和效果：

规则

• 指定RemindTypes，会触发符合签署人NotifyType的通知类型
  • 这里EMAIL类型例外，如果指定了RemindEmailInfos，那么就会按照指定的email来通知，不管签署人NotifyType是否设置了EMAIL通知类型
    • 如果指定了RemindEmailInfos，那么就会按照指定的email来通知
• 若未指定RemindTypes，则按照发起合同时设置的签署人原始通知类型处理

效果

注：合同催办是白名单功能，请联系客户经理申请开白后使用

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 合同催办

针对合同流程中尚未完成签署的用户发送催办消息。
部分合同流程可以催办，而部分则无法催办。
通过查看返回的详细信息清单，可了解各合同流程的催办结果。

输入示例

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

{
    "Operator": {
        "UserId": "yDxMkUyxxxxxxxxxxxVI2JmKxPkk"
    },
    "FlowIds": [
        "yDwXiUUc******************SZ0uIW72Qaxm",
        "yDwFmUU******************BSat8PWOt2iQF"
    ]
}

输出示例

{
    "Response": {
        "RemindFlowRecords": [
            {
                "CanRemind": true,
                "FlowId": "yDwXiUUc******************SZ0uIW72Qaxm",
                "RemindMessage": ""
            },
            {
                "CanRemind": false,
                "FlowId": "yDwFmUU******************BSat8PWOt2iQF",
                "RemindMessage": "签署人 xxx: 此签署人已催办过"
            }
        ],
        "RequestId": "s16*********203499"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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