1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
系统默认角色说明可参考下表
| 角色名称 | 建议授予对象 | 角色描述 |
|---|---|---|
| 超级管理员 | 电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 |
| 业务管理员 | IT 系统负责人，可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
| 经办人 | 企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
| 业务员 | 销售员、采购员 等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChannelDescribeRoles。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
| Limit | 是 | String | 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。 注: 因为历史原因, 此字段为字符串类型示例值：10 |
| Filters.N | 否 | Array of Filter | 查询的关键字段: Key:"RoleType",Values:["1"]查询系统角色， Key:"RoleType",Values:["2"]查询自定义角色 Key:"RoleStatus",Values:["1"]查询启用角色 Key:"RoleStatus",Values:["2"]查询禁用角色 Key:"IsReturnPermissionGroup"，Values:["0"]表示接口不返回角色对应的权限树字段 Key:"IsReturnPermissionGroup"，Values:["1"]表示接口返回角色对应的权限树字段 注: 同名字的Key的过滤条件会冲突, 只能填写一个 |
| Offset | 否 | Integer | 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。 注： 1. offset从0开始，即第一页为0。2. 默认从第一页返回。示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Offset | Integer | 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。 示例值：0 |
| Limit | Integer | 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。 示例值：10 |
| TotalCount | Integer | 查询角色的总数量 示例值：1 |
| ChannelRoles | Array of ChannelRole | 查询的角色信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询角色列表
IsReturnPermissionGroup设置为0表示不返回角色对应的权限树信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeRoles
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Limit": "10",
"Filters": [
{
"Key": "IsReturnPermissionGroup",
"Values": [
"0"
]
}
]
}输出示例
{
"Response": {
"Offset": 1,
"Limit": 10,
"TotalCount": 1,
"ChannelRoles": [
{
"RoleId": "abc8jkkjds***121212",
"RoleName": "业务管理员",
"RoleStatus": 1
}
],
"RequestId": " s19ksdjkkds****ldsjfkdfdf"
}
}示例2 查询角色列表（返回权限树信息）
- IsReturnPermissionGroup设置为1表示返回角色对应的权限树信息
- RoleType设置为2表示只拉取自己创建的角色列表
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeRoles
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Limit": "10",
"Filters": [
{
"Key": "RoleType",
"Values": [
"1"
]
},
{
"Key": "IsReturnPermissionGroup",
"Values": [
"1"
]
}
]
}输出示例
{
"Response": {
"Offset": 0,
"Limit": 10,
"TotalCount": 1,
"ChannelRoles": [
{
"RoleId": "69997f600a7c8e9accc71f4241a8a091",
"RoleName": "类管理员角色",
"RoleStatus": 1,
"PermissionGroups": [
{
"GroupName": "费用中心",
"GroupKey": "bill",
"Hide": 0,
"Permissions": [
{
"Name": "费用管理",
"Key": "BillManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "订单管理",
"Key": "BillOrderManagement",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "套餐管理",
"Key": "BillSetMealManagement",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "发票管理",
"Key": "BillInvoiceManagement",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
},
{
"GroupName": "开发者中心",
"GroupKey": "channel",
"Hide": 0,
"Permissions": [
{
"Name": "渠道模板控件管理",
"Key": "WidgetManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "渠道控件查看",
"Key": "DescribeChannelComponents",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "渠道控件编辑",
"Key": "InsertOrModifyChannelComponents",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "渠道控件删除",
"Key": "DeleteChannelComponents",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "渠道模板库管理",
"Key": "ChannelTemplateManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "渠道模板库查看",
"Key": "DescribeChannelTemplate",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "渠道模板库编辑",
"Key": "InsertOrModifyChannelTemplate",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "渠道模板库删除",
"Key": "DeleteChannelTemplate",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
},
{
"GroupName": "拓展服务",
"GroupKey": "ExpandService",
"Hide": 0,
"Permissions": [
{
"Name": "合同相关",
"Key": "FlowRelatedManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "企业自动签署",
"Key": "CompanyAutoSign",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "批量签署授权",
"Key": "BatchSignAccredit",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "企业与港澳台居民签署合同",
"Key": "OverseasSign",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "拓宽签署方年龄限制",
"Key": "ExpandSignAgeLimit",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "个人签署方仅校验手机号",
"Key": "SignatoryMobileVerify",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "隐藏合同经办人姓名",
"Key": "HideFlowOperatorName",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "印章相关",
"Key": "SealRelatedManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "骑缝章",
"Key": "PagingSeal",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "模板相关",
"Key": "TemplateRelatedManagement",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "审批相关",
"Key": "ApprovalRelatedManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "审批流配置",
"Key": "ApprovalFlowConfig",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "其它拓展服务",
"Key": "OtherExpandManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "企业CA证书配置",
"Key": "CompanyCAConfig",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "下载企业合同/文件授权",
"Key": "AuthProxyOrgDownLoadFlow",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
},
{
"GroupName": "合同中心",
"GroupKey": "Flow",
"Hide": 0,
"Permissions": [
{
"Name": "查询合同",
"Key": "FlowsManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 1,
"DataType": 2,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "企业全部合同",
"Key": "DescribeAllFlows",
"Type": 2,
"Hide": 0,
"DataLabel": 2,
"DataType": 0,
"DataRange": 1,
"DataTo": "",
"ParentKey": "FlowsManagement",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "合同详情&预览",
"Key": "FlowsManagement-Preview",
"Type": 1,
"Hide": 0,
"DataLabel": 1,
"DataType": 1,
"DataRange": 0,
"DataTo": "FlowsManagement",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "下载合同",
"Key": "FlowsManagement-Download",
"Type": 1,
"Hide": 0,
"DataLabel": 1,
"DataType": 1,
"DataRange": 0,
"DataTo": "FlowsManagement",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "发起合同",
"Key": "CreateFlow",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "上传文件发起",
"Key": "FlowByImportedFile",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "企业模版发起",
"Key": "FlowByOrganizationTemplate",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "创建签署二维码",
"Key": "CreateMultiFlowSignQRCode",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "领取合同",
"Key": "FlowsManagement-Pickup",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "撤销合同",
"Key": "CancelFlow",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "申请签署报告",
"Key": "ApplyEvidenceReport",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"GroupName": "组织员工",
"GroupKey": "Organization",
"Hide": 0,
"Permissions": [
{
"Name": "组织架构管理",
"Key": "OrgManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "为员工分配角色",
"Key": "CreateUserRoles",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "编辑组织架构",
"Key": "ModifyYuFuOrg",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "角色管理",
"Key": "RoleManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "创建角色",
"Key": "CreateRole",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "修改角色",
"Key": "ModifyRole",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "删除角色",
"Key": "DeleteRole",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "启用&禁用角色",
"Key": "ModifyRoleStatus",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "添加员工",
"Key": "CreateRoleUsers",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "取消关联",
"Key": "DeleteRoleUsers",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
},
{
"GroupName": "印章中心",
"GroupKey": "Seal",
"Hide": 0,
"Permissions": [
{
"Name": "我持有企业印章",
"Key": "SealManagement-Hold",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "查询印章",
"Key": "QueryHoldSeal",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "印章管理",
"Key": "SealManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "查询印章",
"Key": "SealManagement-Manage-Detail",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "授权记录",
"Key": "SealManagement-Manage-Detail-Holder",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "关联模版",
"Key": "SealManagement-Manage-Detail-Holder-Template",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "用印记录",
"Key": "SealManagement-Manage-Detail-Holder-Use-Record",
"Type": 2,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "变更记录",
"Key": "SealManagement-Manage-Detail-Holder-Change-Record",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "创建印章",
"Key": "CreateSeal",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "新建印章-模版印章",
"Key": "SealManagement-Manage-Create-Template",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "新建印章-本地上传",
"Key": "SealManagement-Manage-Create-Upload",
"Type": 1,
"Hide": 1,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
},
{
"Name": "修改印章",
"Key": "ModifySeal",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "分配印章管理人",
"Key": "CreateSealPolicy",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "删除印章",
"Key": "DeleteSeal",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "单次用印审批",
"Key": "ApplySealOnce",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
},
{
"GroupName": "模板中心",
"GroupKey": "Template",
"Hide": 0,
"Permissions": [
{
"Name": "模板管理",
"Key": "TemplateManagement",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": [
{
"Name": "查询模板",
"Key": "TemplateManagement-Query",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "官方模板收藏",
"Key": "OfficialFlowTemplateCollection",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "下载模板",
"Key": "TemplateManagement-Download",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "创建模板",
"Key": "TemplateManagement-Create",
"Type": 1,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "删除模板",
"Key": "DeleteFlowTemplates",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
},
{
"Name": "编辑模板",
"Key": "ModifyFlowTemplate",
"Type": 2,
"Hide": 0,
"DataLabel": 0,
"DataType": 0,
"DataRange": 0,
"DataTo": "",
"ParentKey": "",
"IsChecked": true,
"Children": []
}
]
}
]
}
]
}
],
"RequestId": "cb9c33e8-2870-42ea-b798-b9fbd4756827"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Limit | 参数Limit不正确 |
| InvalidParameter.Offset | 参数Offset不正确 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.Application | 应用号不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
