员工Userid与客户系统Openid绑定

1. 接口描述

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

此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。

此OpenId只在 更新企业员工信息 、移除企业员工 等场景下可以使用

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：BindEmployeeUserIdWithClientOpenId。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写UserId。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
UserId	是	String	员工在腾讯电子签平台的唯一身份标识，为32位字符串。 通过DescribeIntegrationEmployees接口获取，也可登录腾讯电子签控制台查看 示例值：yDtwEUUckp7f8w6uUuBHsZJd9KcpXpMH
OpenId	是	String	员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。 示例值：n9527
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
Status	Integer	绑定是否成功。 0：失败 1：成功 示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 员工Userid与客户系统Openid绑定

传入UserId和OpenId，绑定成功。

输入示例

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

{
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "UserId": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68",
    "OpenId": "n9527"
}

输出示例

{
    "Response": {
        "RequestId": "fc0b0a6b-01b4-4042-b236-c5356af1d5d8",
        "Status": 1
    }
}

示例2 错误示例-重复使用OpenId绑定其他UserId

输入示例

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

{
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "UserId": "yDSLmUUckpou8bj8UyvAk4FBqAoWzvy4",
    "OpenId": "n9527"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter",
            "Message": "该openid已绑定其他userid，请解绑后重试"
        },
        "RequestId": "535482ad-caa5-4302-909c-de054bf4df99"
    }
}

示例3 错误示例-重复使用OpenId绑定同一个UserId

接口绑定是不幂等的

输入示例

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

{
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "UserId": "yDSLmUUckpou8bj8UyvAk4FBqAoWzvy4",
    "OpenId": "n9527"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter",
            "Message": "该userId已绑定该openId，无需重新绑定"
        },
        "RequestId": "535482ad-caa5-4302-909c-de054bf4df99"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ParamError	参数错误。
MissingParameter	缺少参数错误。