查询角色列表
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChannelDescribeRoles。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
| Limit | 是 | String | 指定每页多少条数据，单页最大200 |
| Filters.N | 否 | Array of Filter | 查询的关键字段: Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色 Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色 Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段 |
| Offset | 否 | Integer | 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Offset | Integer | 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000 |
| Limit | Integer | 指定每页多少条数据，单页最大200 |
| TotalCount | Integer | 查询角色的总数量 |
| ChannelRoles | Array of ChannelRole | 角色信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询角色列表
查询角色列表，默认不返回角色对应的权限树信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeRoles
<公共请求参数>
{
"Agent": {
"AppId": " jsdk812kxkdfjks***k88123123",
"ProxyOrganizationOpenId": "test_org_openid",
"ProxyOperator": {
"OpenId": "test_openid"
}
},
"Filters": [
{
"Key": "",
"Values": [
""
]
}
],
"Offset": 1,
"Limit": "abc"
}
输出示例
{
"Response": {
"Offset": 1,
"Limit": 1,
"TotalCount": 1,
"ChannelRoles": [
{
"RoleId": "abc8jkkjds***121212",
"RoleName": "业务管理员",
"RoleStatus": 1
}
],
"RequestId": " s19ksdjkkds****ldsjfkdfdf"
}
}
示例2 查询角色列表（返回权限树信息）
查询角色列表，增加查询筛选条件“IsReturnPermissionGroup”，将返回角色对应的权限树信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeRoles
<公共请求参数>
{
"Agent": {
"AppId": " jsdk812kxkdfjks***k88123123",
"ProxyOrganizationOpenId": "test_org_openid",
"ProxyOperator": {
"OpenId": "test_openid"
}
},
"Filters": [
{
"Key": "IsReturnPermissionGroup",
"Values": [
"1"
]
}
],
"Offset": 1,
"Limit": "abc"
}
输出示例
{
"Response": {
"Offset": 1,
"Limit": 1,
"TotalCount": 1,
"ChannelRoles": [
{
"RoleId": "abc8jkkjds***121212",
"RoleName": "业务管理员",
"RoleStatus": 1,
"PermissionGroups": [
{
"GroupKey": "bill",
"GroupName": "费用中心",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "BillOrderManagement",
"Name": "订单管理",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "BillSetMealManagement",
"Name": "套餐管理",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "BillInvoiceManagement",
"Name": "发票管理",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": false,
"Key": "BillManagement",
"Name": "费用管理",
"ParentKey": "",
"Type": 1
}
]
},
{
"GroupKey": "channel",
"GroupName": "开发者中心",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DescribeChannelComponents",
"Name": "渠道控件查看",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "InsertOrModifyChannelComponents",
"Name": "渠道控件编辑",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DeleteChannelComponents",
"Name": "渠道控件删除",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": false,
"Key": "WidgetManagement",
"Name": "渠道模板控件管理",
"ParentKey": "",
"Type": 1
},
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DescribeChannelTemplate",
"Name": "渠道模板库查看",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "InsertOrModifyChannelTemplate",
"Name": "渠道模板库编辑",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DeleteChannelTemplate",
"Name": "渠道模板库删除",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": false,
"Key": "ChannelTemplateManagement",
"Name": "渠道模板库管理",
"ParentKey": "",
"Type": 1
}
]
},
{
"GroupKey": "Flow",
"GroupName": "合同中心",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 2,
"DataRange": 1,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "DescribeAllFlows",
"Name": "企业全部合同",
"ParentKey": "FlowsManagement",
"Type": 2
}
],
"DataLabel": 1,
"DataRange": 0,
"DataTo": "",
"DataType": 2,
"Hide": 0,
"IsChecked": true,
"Key": "FlowsManagement",
"Name": "查询合同",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 1,
"DataRange": 0,
"DataTo": "FlowsManagement",
"DataType": 1,
"Hide": 0,
"IsChecked": true,
"Key": "FlowsManagement-Preview",
"Name": "合同详情&预览",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 1,
"DataRange": 0,
"DataTo": "FlowsManagement",
"DataType": 1,
"Hide": 0,
"IsChecked": true,
"Key": "FlowsManagement-Download",
"Name": "下载合同",
"ParentKey": "",
"Type": 1
},
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "FlowByImportedFile",
"Name": "上传文件发起",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "FlowByOrganizationTemplate",
"Name": "企业模版发起",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "CreateMultiFlowSignQRCode",
"Name": "创建签署二维码",
"ParentKey": "",
"Type": 1
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "CreateFlow",
"Name": "发起合同",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "FlowsManagement-Pickup",
"Name": "领取合同",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "CancelFlow",
"Name": "撤销合同",
"ParentKey": "",
"Type": 2
}
]
},
{
"GroupKey": "Organization",
"GroupName": "组织员工",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "CreateUserRoles",
"Name": "为员工分配角色",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "ModifyYuFuOrg",
"Name": "编辑组织架构",
"ParentKey": "",
"Type": 1
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "OrgManagement",
"Name": "组织架构管理",
"ParentKey": "",
"Type": 1
},
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "CreateRole",
"Name": "创建角色",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "ModifyRole",
"Name": "修改角色",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DeleteRole",
"Name": "删除角色",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "ModifyRoleStatus",
"Name": "启用&禁用角色",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "CreateRoleUsers",
"Name": "添加员工",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": false,
"Key": "DeleteRoleUsers",
"Name": "取消关联",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": false,
"Key": "RoleManagement",
"Name": "角色管理",
"ParentKey": "",
"Type": 1
}
]
},
{
"GroupKey": "Seal",
"GroupName": "印章中心",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "QueryHoldSeal",
"Name": "查询印章",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "SealManagement-Hold",
"Name": "我持有企业印章",
"ParentKey": "",
"Type": 1
},
{
"Children": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Detail-Holder",
"Name": "授权记录",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Detail-Holder-Template",
"Name": "关联模版",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Detail-Holder-Use-Record",
"Name": "用印记录",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Detail-Holder-Change-Record",
"Name": "变更记录",
"ParentKey": "",
"Type": 1
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "SealManagement-Manage-Detail",
"Name": "查询印章",
"ParentKey": "",
"Type": 2
},
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Create-Template",
"Name": "新建印章-模版印章",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 1,
"IsChecked": true,
"Key": "SealManagement-Manage-Create-Upload",
"Name": "新建印章-本地上传",
"ParentKey": "",
"Type": 1
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "CreateSeal",
"Name": "创建印章",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "ModifySeal",
"Name": "修改印章",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "CreateSealPolicy",
"Name": "分配印章管理人",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "DeleteSeal",
"Name": "删除印章",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "ApplySealOnce",
"Name": "单次用印审批",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "SealManagement",
"Name": "印章管理",
"ParentKey": "",
"Type": 1
}
]
},
{
"GroupKey": "Template",
"GroupName": "模板中心",
"Hide": 0,
"Permissions": [
{
"Children": [
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "TemplateManagement-Query",
"Name": "查询模板",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "OfficialFlowTemplateCollection",
"Name": "官方模板收藏",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "TemplateManagement-Download",
"Name": "下载模板",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "TemplateManagement-Create",
"Name": "创建模板",
"ParentKey": "",
"Type": 1
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "DeleteFlowTemplates",
"Name": "删除模板",
"ParentKey": "",
"Type": 2
},
{
"Children": [],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "ModifyFlowTemplate",
"Name": "编辑模板",
"ParentKey": "",
"Type": 2
}
],
"DataLabel": 0,
"DataRange": 0,
"DataTo": "",
"DataType": 0,
"Hide": 0,
"IsChecked": true,
"Key": "TemplateManagement",
"Name": "模板管理",
"ParentKey": "",
"Type": 1
}
]
}
]
}
],
"RequestId": " s19ksdjkkds****ldsjfkdfdf"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Limit | 参数Limit不正确 |
| InvalidParameter.Offset | 参数Offset不正确 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.Application | 应用号不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |