跳到主要内容

合同催办

1. 接口描述​

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

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

  1. 合同中当前状态为 待签署 的签署人是催办的对象
  2. 每个合同只能催办一次

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

image

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateFlowReminds。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
FlowIds.N是Array of String需执行催办的合同流程ID数组，最多支持100个。
示例值：["yDSL5UUckpok9bd0UvwoHnxmejhdsSKL"]

3. 输出参数​

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

4. 示例​

示例1 合同催办​

因为yDSL5UUckpokxl92UvwoHnSHf4RPOgu5我已经催办过, 所以返回"签署人 张三: 此签署人已催办过；", 对方不会在收到催办短信 yDSL5UUckpok9bd0UvwoHnxmejhdsSKL和yDSL5UUckpok4vmvUu7BBPOShktz8qHN催办成功, 对方收到短信

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDSL5UUckpok9bd0UvwoHnxmejhdsSKL",
        "yDSL5UUckpokxl92UvwoHnSHf4RPOgu5",
        "yDSL5UUckpok4vmvUu7BBPOShktz8qHN"
    ]
}

输出示例​

{
    "Response": {
        "RemindFlowRecords": [
            {
                "CanRemind": true,
                "FlowId": "yDSL5UUckpok9bd0UvwoHnxmejhdsSKL",
                "RemindMessage": "签署人 王五: 催办成功；"
            },
            {
                "CanRemind": true,
                "FlowId": "yDSL5UUckpokxl92UvwoHnSHf4RPOgu5",
                "RemindMessage": "签署人 张三: 此签署人已催办过；"
            },
            {
                "CanRemind": true,
                "FlowId": "yDSL5UUckpok4vmvUu7BBPOShktz8qHN",
                "RemindMessage": "签署人 张三: 催办成功；签署人 李四: 催办成功；"
            }
        ],
        "RequestId": "4ad2f917-5c8e-4071-bae7-caa43387d0c3"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InvalidParameterValue参数取值错误。
OperationDenied操作被拒绝。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。