绑定员工角色

1. 接口描述

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

使用此接口，用来绑定企业实名员工的角色，支持以电子签userId、客户系统openId两种方式进行绑定。

对应控制台的操作如下图

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateUserRoles。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
RoleIds.N	是	Array of String	绑定角色的角色id列表，最多 100 个
UserIds.N	否	Array of String	电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多 100 个
OpenIds.N	否	Array of String	客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多 100 个

3. 输出参数

参数名称	类型	描述
FailedCreateRoleData	Array of FailedCreateRoleData	绑定失败的用户角色列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定用户角色

绑定用户角色

输入示例

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

{
    "Agent": {
        "AppId": "sdkdk78193cksc9s***k9dfk",
        "ProxyOrganizationOpenId": "test_org_openid",
        "ProxyOperator": {
            "OpenId": "test_openid"
        }
    },
    "UserIds": [
        "ywksdkj1001***103kd"
    ],
    "RoleIds": [
        "ywk9kdki323****k239239"
    ]
}

输出示例

{
    "Response": {
        "FailedCreateRoleData": [],
        "RequestId": " s129023***12003023"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 绑定用户角色​

输入示例​

输出示例​

5. 错误码​