跳到主要内容

绑定员工角色

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelCreateUserRoles。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
RoleIds.NArray of String绑定角色的角色id列表,最多 100 个
UserIds.NArray of String电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数,最多 100 个
OpenIds.NArray of String客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数,最多 100 个

3. 输出参数

参数名称类型描述
FailedCreateRoleDataArray of FailedCreateRoleData绑定失败的用户角色列表
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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操作被拒绝。