合同组催办

1. 接口描述

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

指定需要批量催办的合同组签署流程ID，按合同组维度进行催办

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

发起合同时，**设置了经办人通知方式**
子合同中当前状态为 **待签署、待填写** 的签署人是催办的对象
**每个合同的每个签署方最多3次*

注意

催办结果会以签署方维度列出（不同公司下的同个员工会被视为两个不同的签署方，同一人分别作为个人签署方与企业签署方也会被视为两个不同的签署方）
合同组只支持短信方式催办

催办的效果：

效果

对方会收到如下的短信通知

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFlowGroupReminds。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
FlowGroupId	是	String	合同(流程)组的合同组Id 示例值：yD3**jJK
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
RemindFlowGroupRecords	Array of RemindFlowGroupRecord	合同组催办接口返回的详细信息。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 合同组催办

输入示例

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

{
    "Operator": {
        "UserId": "yDCH5UUckpax3h9wUxHw4XzSpBev1wRg"
    },
    "FlowGroupId": "yD3**************************jJK"
}

输出示例

{
    "Response": {
        "RemindFlowGroupRecords": [
            {
                "ApproverName": "叶**",
                "FlowIds": [
                    "yD3**************************VCw"
                ],
                "FlowNames": [
                    "合同组(2份合同)-单C-2"
                ],
                "Mobile": "156****8190",
                "RemindMessageList": [
                    {
                        "ApproverOrder": 0,
                        "Reason": "催办成功（短信）",
                        "SignId": "yD3**************************9gk",
                        "Status": 0
                    }
                ]
            }
        ],
        "RequestId": "52332bdd-67a4-4fb9-9efe-3a051b7c6c5d"
    }
}

5. 错误码

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

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

1. 接口描述​

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

催办的效果：​

效果​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 合同组催办​

输入示例​

输出示例​

5. 错误码​