1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
该接口用于将合同中本企业当前经办人转为本企业其他员工进行操作。
注意:
- 转交的目标经办人需要已经加入企业,且完成实名。
- 仅企业拥有
超管
、法人
或者合同管理员
角色的员工才有调用本接口的权限。如果使用主带子方式调用,请确保您已经加入子企业,且账号在子企业中担任任一上述角色。 - 仅支持当前经办人为待签署或待填写状态时进行转交操作。
- 若原合同有填写控件,且当前经办人已经完成填写,则不支持进行转交。
- 若当前经办人已签署完成,或者处于签署流程中,则不支持进行转交。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateFlowForwards。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
TargetUserId | 是 | String | 合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。 注意: 需要保证目标经办人已经加入企业且已实名 示例值:yDwfGUieurag8Uy0AthwPa6bOntYp6x0 |
FlowForwardInfos.N | 是 | Array of FlowForwardInfo | 企业签署方的合同及对应签署方 |
Agent | 否 | Agent | 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FailedFlows | Array of FlowForwardResult | 失败的合同id以及错误详情 |
SuccessFlows | Array of String | 成功的合同id 示例值:["yDtCvUUlal1z9fUEyCjfI8TAPPwBtFzu"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 将当前合同经办人转为其他员工
将当前合同经办人转为其他员工
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowForwards
<公共请求参数>
{
"TargetUserId": "yDCkSUUck******************BQnKvKPVf",
"FlowForwardInfos": [
{
"FlowId": "yDtSPUU**********************PHG7JhZM",
"RecipientId": "yDtSPUU******************os8flxcvLpj"
},
{
"FlowId": "yDtSPUU**********************PHG7s8flx",
"RecipientId": "yDtSPUU******************oSPUxSP"
}
],
"Operator": {
"UserId": "yDtSPUU******************p4z5lt9UuY",
"ClientIp": "116.211.195.11"
}
}
输出示例
{
"Response": {
"FailedFlows": [
{
"ErrorDetail": "转发人状态非待签署或待填写,禁止转发",
"FlowId": "yDtSPUU**********************PHG7JhZM"
}
],
"RequestId": "s1740641173120185806",
"SuccessFlows": [
"yDtSPUU**********************PHG7s8flx"
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.BalanceNotEnough | 套餐余额不足。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |