跳到主要内容

合同催办

1. 接口描述

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

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

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

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

image

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称类型描述
RemindFlowRecordsArray of RemindFlowRecords合同催办结果的详细信息列表。
RequestIdString唯一请求 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. 错误码

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

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