有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。

适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。

适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。

适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。

适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。

注意事项:SaaS角色和集团角色对应的权限树是不一样的。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateIntegrationRole。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
Name String 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
Operator UserInfo 执行本接口操作的员工信息。使用此接口时,必须填写userId。
支持填入集团子公司经办人 userId 代发合同。

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
Description String 角色描述,最大长度为50个字符
IsGroupRole Integer 角色类型,0:saas角色,1:集团角色
默认0,saas角色
PermissionGroups.N Array of PermissionGroup 权限树
SubOrganizationIds String 集团角色的话,需要传递集团子企业列表,如果是全选,则传1
Agent Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称 类型 描述
RoleId String 角色id
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例-主代子创建角色

主企业代理子企业创建角色,设置 Agent 参数,并设置 ProxyOrganizationId 为子企业id

输入示例

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

{
    "Name": "业务员角色",
    "Description": "这是角色描述信息",
    "IsGroupRole": 0,
    "Operator": {
        "UserId": "y******************5"
    },
    "Agent": {
        "ProxyOrganizationId": "y**********************J"
    }
}

输出示例

{
    "Response": {
        "RoleId": "abc",
        "RequestId": "abc"
    }
}

示例2 示例-普通企业创建角色(带权限树参数)

创建角色并同时设置角色中的权限内容,设置权限树参数 PermissionGroups ,PermissionGroups 展开为树形结构,可以需要的权限节点下将 IsChecked 属性设置为true。
注意:父权限节点 IsChecked 属性为true,则需要将其下所有子节点的 IsChecked属性同时设置为true,否则校验不通过。

输入示例

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

{
    "Name": "业务员角色",
    "Description": "这是角色描述信息",
    "IsGroupRole": 0,
    "Operator": {
        "UserId": "y******************5"
    },
    "PermissionGroups": [
        {
            "GroupKey": "Flow",
            "GroupName": "合同中心",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "UserFlowTypesManagement",
                    "Name": "合同类型管理",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 1,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "DescribeAllFlows",
                                    "Name": "企业全部合同",
                                    "ParentKey": "FlowsManagement",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 2,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "FlowsManagement-Department",
                                    "Name": "本部门全部合同",
                                    "ParentKey": "FlowsManagement",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 2,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "FlowsManagement",
                            "Name": "查询合同",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "FlowsManagement",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DownloadFlow",
                            "Name": "下载合同",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "FlowByImportedFile",
                                    "Name": "上传文件发起",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [
                                        {
                                            "Children": [],
                                            "DataLabel": 2,
                                            "DataRange": 1,
                                            "DataTo": "",
                                            "DataType": 0,
                                            "Hide": 0,
                                            "IsChecked": false,
                                            "Key": "FlowByOrganizationTemplate-All",
                                            "Name": "本企业全部模板",
                                            "ParentKey": "FlowByOrganizationTemplate",
                                            "Type": 2
                                        },
                                        {
                                            "Children": [],
                                            "DataLabel": 2,
                                            "DataRange": 2,
                                            "DataTo": "",
                                            "DataType": 0,
                                            "Hide": 0,
                                            "IsChecked": false,
                                            "Key": "FlowByOrganizationTemplate-Department",
                                            "Name": "本部门全部模板",
                                            "ParentKey": "FlowByOrganizationTemplate",
                                            "Type": 2
                                        },
                                        {
                                            "Children": [],
                                            "DataLabel": 2,
                                            "DataRange": 3,
                                            "DataTo": "",
                                            "DataType": 0,
                                            "Hide": 0,
                                            "IsChecked": false,
                                            "Key": "FlowByOrganizationTemplate-Own",
                                            "Name": "本人创建模板",
                                            "ParentKey": "FlowByOrganizationTemplate",
                                            "Type": 2
                                        }
                                    ],
                                    "DataLabel": 1,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 2,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "FlowByOrganizationTemplate",
                                    "Name": "企业模板发起",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "CreateMultiFlowSignQRCode",
                                    "Name": "创建签署二维码",
                                    "ParentKey": "",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateFlow",
                            "Name": "发起合同",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateMultipleFlow",
                            "Name": "批量发起合同",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "FlowsManagement",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CancelFlow",
                            "Name": "撤销合同",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "SetUserFlowTypes",
                            "Name": "设置合同所属类型",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "RelieveFlows",
                            "Name": "解除合同",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "BatchSignAccredit",
                            "Name": "批量签署授权",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DraftFlow",
                            "Name": "起草合同",
                            "ParentKey": "",
                            "Type": 1
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "Flows",
                    "Name": "合同文件夹",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "GroupKey": "Template",
            "GroupName": "模板中心",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 1,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "PreviewFlowTemplate-All",
                                    "Name": "本企业全部模板",
                                    "ParentKey": "PreviewFlowTemplate",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 2,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "PreviewFlowTemplate-Department",
                                    "Name": "本部门全部模板",
                                    "ParentKey": "PreviewFlowTemplate",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 3,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "PreviewFlowTemplate-Own",
                                    "Name": "本人创建模板",
                                    "ParentKey": "PreviewFlowTemplate",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 2,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "PreviewFlowTemplate",
                            "Name": "查询模板",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "PreviewFlowTemplate",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DownloadFlowTemplate",
                            "Name": "下载模板",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateFlowTemplate",
                            "Name": "创建模板",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "PreviewFlowTemplate",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DeleteFlowTemplates",
                            "Name": "删除模板",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "PreviewFlowTemplate",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ModifyFlowTemplate",
                            "Name": "编辑模板",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "OfficialFlowTemplateCollection",
                            "Name": "官方模板收藏",
                            "ParentKey": "",
                            "Type": 1
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "TemplateManagement",
                    "Name": "模板管理",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "GroupKey": "Seal",
            "GroupName": "印章中心",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "QueryHoldSeal",
                            "Name": "查询印章",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "HoldSeal",
                    "Name": "我持有企业印章",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 1,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "QuerySeal-All",
                                    "Name": "本企业全部印章",
                                    "ParentKey": "QuerySeal",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 2,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "QuerySeal-Department",
                                    "Name": "本部门全部印章",
                                    "ParentKey": "QuerySeal",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 2,
                                    "DataRange": 3,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 0,
                                    "IsChecked": false,
                                    "Key": "QuerySeal-Own",
                                    "Name": "本人创建印章",
                                    "ParentKey": "QuerySeal",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 1,
                                    "DataRange": 0,
                                    "DataTo": "QuerySeal",
                                    "DataType": 1,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "QueryAuthSeal",
                                    "Name": "授权记录",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 1,
                                    "DataRange": 0,
                                    "DataTo": "QuerySeal",
                                    "DataType": 1,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "AssociationTemplate",
                                    "Name": "关联模版",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 1,
                                    "DataRange": 0,
                                    "DataTo": "QuerySeal",
                                    "DataType": 1,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "SealRecord",
                                    "Name": "用印记录",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 1,
                                    "DataRange": 0,
                                    "DataTo": "QuerySeal",
                                    "DataType": 1,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "ChangeRecord",
                                    "Name": "变更记录",
                                    "ParentKey": "",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 2,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "QuerySeal",
                            "Name": "查询印章",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "TemplateSeal",
                                    "Name": "模版印章",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "LocalUploadSeal",
                                    "Name": "本地上传",
                                    "ParentKey": "",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateSeal",
                            "Name": "添加印章",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "QuerySeal",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ModifySeal",
                            "Name": "启停用印章",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "QuerySeal",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateSealPolicy",
                            "Name": "授权持有人",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "QuerySeal",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DeleteSeal",
                            "Name": "删除印章",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 1,
                            "DataRange": 0,
                            "DataTo": "QuerySeal",
                            "DataType": 1,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ApplySealOnce",
                            "Name": "单次用印审批",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "SealManagement",
                    "Name": "印章管理",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "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": 0,
                            "IsChecked": false,
                            "Key": "DescribeApplication",
                            "Name": "企业应用查看",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ModifyApplication",
                            "Name": "企业应用编辑",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ApplicationIntegrate",
                    "Name": "应用集成",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ChannelUserFlowTypesManagement",
                    "Name": "渠道合同类型管理",
                    "ParentKey": "",
                    "Type": 2
                },
                {
                    "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
                }
            ]
        },
        {
            "GroupKey": "Organization",
            "GroupName": "组织员工",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [
                        {
                            "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": "启用u0026禁用角色",
                            "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
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "CreateRole",
                            "Name": "创建角色",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "RoleManagement",
                    "Name": "角色管理",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "CreateUserRoles",
                            "Name": "为员工分配角色",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "ModifyYuFuOrg",
                            "Name": "编辑组织架构",
                            "ParentKey": "",
                            "Type": 1
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "OrgManagement",
                    "Name": "组织架构管理",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "GroupOrgCreate",
                            "Name": "集团组织创建",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "GroupOrgQuery",
                            "Name": "集团组织查询",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "GroupOrgMemberManagement",
                            "Name": "集团成员管理",
                            "ParentKey": "",
                            "Type": 1
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "GroupOrgManagement",
                    "Name": "集团组织管理",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "GroupKey": "Reseller",
            "GroupName": "分销商助手",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "StartResell",
                    "Name": "分销开单",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ResellTool",
                            "Name": "购买并发货",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "PreOrderAndSendOutGoods",
                            "Name": "从预购额度发货",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "BuyAndSendOutGoods",
                    "Name": "发货工具",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 2,
                            "DataRange": 3,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ResellOrders-Own",
                            "Name": "本人销售记录",
                            "ParentKey": "ResellOrders",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 2,
                            "DataRange": 1,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ResellOrders-All",
                            "Name": "所有销售记录",
                            "ParentKey": "ResellOrders",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ResellOrders",
                    "Name": "销售记录",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ResellConsumeAnalysis",
                    "Name": "客户消耗分析",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ResellPerformanceData",
                    "Name": "业绩数据",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ResellAdminLearningMaterials",
                            "Name": "管理员学习资料",
                            "ParentKey": "",
                            "Type": 1
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ResellOperatorLearningMaterials",
                            "Name": "业务员学习资料",
                            "ParentKey": "",
                            "Type": 1
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ResellLearningMaterials",
                    "Name": "学习资料",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ActivityManagement",
                    "Name": "活动管理",
                    "ParentKey": "",
                    "Type": 2
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "PreOrderOverview",
                    "Name": "预购总览",
                    "ParentKey": "",
                    "Type": 2
                }
            ]
        },
        {
            "GroupKey": "fulfill",
            "GroupName": "服务预约",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "AppointmentMerchantService",
                            "Name": "代客预约",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "WriteOffForCustomerService",
                            "Name": "代客核销",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DescribeFulfillAppointments",
                            "Name": "查看记录",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "AppointmentManagement",
                    "Name": "预约记录",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DescribeFulfillOrganizationConsumers",
                            "Name": "查看顾客",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateFulfillOrganizationConsumer",
                            "Name": "添加顾客",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ModifyFulfillOrganizationConsumer",
                            "Name": "编辑顾客",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DeleteFulfillOrganizationConsumer",
                            "Name": "删除顾客",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DescribeFulfillConsumersWithExcel",
                            "Name": "导出",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "CreateFulfillConsumerContract",
                            "Name": "添加/更新合同",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ConsumerService",
                    "Name": "顾客列表",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "ManageFulfillShops",
                            "Name": "店铺信息管理",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ShopService",
                    "Name": "店铺管理",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 0,
                            "IsChecked": false,
                            "Key": "DescribeFulfillDataDashboard",
                            "Name": "查看",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "DataDashboard",
                    "Name": "数据看板",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "GroupKey": "Company",
            "GroupName": "企业中心",
            "Hide": 1,
            "Permissions": [
                {
                    "Children": [
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "QueryEnterpriseInfo",
                            "Name": "企业信息查询",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "BindingAgent",
                            "Name": "绑定代理商",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 1,
                    "IsChecked": false,
                    "Key": "Company-Account",
                    "Name": "企业信息",
                    "ParentKey": "",
                    "Type": 1
                },
                {
                    "Children": [
                        {
                            "Children": [
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "Company-Serves-ServerSign-Open",
                                    "Name": "开通u0026关闭",
                                    "ParentKey": "",
                                    "Type": 2
                                },
                                {
                                    "Children": [],
                                    "DataLabel": 0,
                                    "DataRange": 0,
                                    "DataTo": "",
                                    "DataType": 0,
                                    "Hide": 1,
                                    "IsChecked": false,
                                    "Key": "Company-Serves-ServerSign-Auth",
                                    "Name": "授权",
                                    "ParentKey": "",
                                    "Type": 2
                                }
                            ],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "Company-Serves-ServerSign",
                            "Name": "企业静默签",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "EnterpriseExtendedServicesSignFlow",
                            "Name": "企业与港澳台居民签署合同",
                            "ParentKey": "",
                            "Type": 2
                        },
                        {
                            "Children": [],
                            "DataLabel": 0,
                            "DataRange": 0,
                            "DataTo": "",
                            "DataType": 0,
                            "Hide": 1,
                            "IsChecked": false,
                            "Key": "ApprovalFlowConfig",
                            "Name": "审批流配置",
                            "ParentKey": "",
                            "Type": 2
                        }
                    ],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 1,
                    "IsChecked": false,
                    "Key": "Company-Serves",
                    "Name": "扩展服务",
                    "ParentKey": "",
                    "Type": 1
                }
            ]
        },
        {
            "GroupKey": "BusinessManagement",
            "GroupName": "企业管理",
            "Hide": 0,
            "Permissions": [
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "StyleConfig",
                    "Name": "样式配置",
                    "ParentKey": "",
                    "Type": 2
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ToolKitConfig",
                    "Name": "工具箱配置",
                    "ParentKey": "",
                    "Type": 2
                },
                {
                    "Children": [],
                    "DataLabel": 0,
                    "DataRange": 0,
                    "DataTo": "",
                    "DataType": 0,
                    "Hide": 0,
                    "IsChecked": false,
                    "Key": "ApprovalFlowConfig",
                    "Name": "审批流程配置",
                    "ParentKey": "",
                    "Type": 2
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RoleId": "abc",
        "RequestId": "abc"
    }
}

示例3 示例-普通企业创建角色(不带权限树参数)

示例-普通企业创建角色(不带权限树参数)

输入示例

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

{
    "Name": "业务员角色",
    "Description": "这是角色描述信息",
    "IsGroupRole": 0,
    "Operator": {
        "UserId": "y******************5"
    }
}

输出示例

{
    "Response": {
        "RoleId": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ParamError 参数错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermissionFeature 请升级到对应版本后即可使用该接口。