跳到主要内容

领取未归属的合同

1. 接口描述​

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

此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。

未归属合同发起方式 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下

        FlowApprovers: []*essbasic.FlowApproverInfo{
            {
                ApproverType:       common.StringPtr("ORGANIZATION"),
                OrganizationOpenId: common.StringPtr("org_dianziqian"),
                OrganizationName:   common.StringPtr("典子谦示例企业"),
            }
        },

可以生成子客登录链接登录控制台查看带领取的合同 image

注: 支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败

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

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

2. 输入参数​

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

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

此接口下面信息必填。

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


第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
FlowIds.N否Array of String需要领取的合同流程的ID列表

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 领取合同成功​

领取2个未归属的合同给当前员工

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDSLZUUckpotp24bUER7iHn1TnyrRvG5",
        "yDSLZUUckpotplq0UELP595SOtvY2jPa"
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "3a00c125-b7fd-4dcb-879c-651bd471ac15"
    }
}

示例2 领取失败​

有一个合同无法被领取就会导致所有的合同无法领取, 例子中的yDSLZUUckpotplq0UELP595SOtvY2jPa已经领取导致请求失败

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDSLZUUckpotp24bUER7iHn1TnyrRvG5",
        "yDSLZUUckpotplq0UELP595SOtvY2jPa"
    ]
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "此签署流程状态无法领取"
        },
        "RequestId": "0f61a7b2-a02d-44b8-9a05-66cd0cbc0d37"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.HasAuthorized已授权。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.DbInsert数据库新增记录出错。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.BusinessLicense营业执照格式不合法。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.FileType文件类型不合法。
InvalidParameter.MenuStatus菜单栏状态非法。
InvalidParameter.OpenIdOpenId不合法。
InvalidParameter.OrganizationIdOrganizationId不合法。
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.ParamError参数错误。
LimitExceeded.FileSize文件大小限制。
MissingParameter缺少参数错误。
MissingParameter.CompanyActiveInfo合作企业激活信息不存在。
MissingParameter.OrgOpenId企业OpenId不存在。
MissingParameter.ProxyOperatorOpenIdProxyOperatorOpenId不存在。
OperationDenied操作被拒绝。
OperationDenied.BannedApplication应用号已被禁止。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.ApplicationIdApplicationId不存在。
ResourceNotFound.Flow未找到对应流程。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。