有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:

  1. 发起合同时,签署人的NotifyType需设置为sms
  2. 合同中当前状态为 待签署 的签署人是催办的对象
  3. 每个合同只能催办一次

催办的效果: 对方会收到如下的短信通知

image

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateFlowReminds。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
Operator UserInfo 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
示例值:yDR***oimj
FlowIds.N Array of String 需执行催办的签署流程ID数组,最多包含100个。
示例值:['yDw*Gm','yDwFmU***Ot2iQF']
Agent Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称 类型 描述
RemindFlowRecords Array of RemindFlowRecords 合同催办结果的详细信息列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

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。

命令行工具

6. 错误码

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

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