跳到主要内容

操作第三方应用平台企业模板

1. 接口描述​

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

此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置，不会直接分配第三方应用平台模板给子客企业。 1、OperateType=select时： 查询第三方应用平台模板库 2、OperateType=update或者delete时： 对子客企业进行模板库中模板可见性的修改、删除操作。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：OperateChannelTemplate。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
OperateType是String操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
TemplateId是String第三方应用平台模板库模板唯一标识
ProxyOrganizationOpenIds否String合作企业方第三方机构唯一标识数据，支持多个， 用","进行分隔
AuthTag否String模板可见性, 全部可见-"all", 部分可见-"part"
Operator否UserInfo暂未开放

3. 输出参数​

参数名称类型描述
AppIdString腾讯电子签颁发给第三方应用平台的应用ID
注意：此字段可能返回 null，表示取不到有效值。
TemplateIdString第三方应用平台模板库模板唯一标识
注意：此字段可能返回 null，表示取不到有效值。
OperateResultString全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
注意：此字段可能返回 null，表示取不到有效值。
AuthTagString模板可见性, 全部可见-"all", 部分可见-"part"
注意：此字段可能返回 null，表示取不到有效值。
ProxyOrganizationOpenIdsArray of String合作企业方第三方机构唯一标识数据
注意：此字段可能返回 null，表示取不到有效值。
FailMessageListArray of AuthFailMessage操作失败信息数组
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询模板库中的模板信息​

查询模板库中的模板信息

输入示例​

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

{
    "Agent": {
        "ProxyAppId": "c17bdf9c2xxxx611f4d0200fef3d",
        "ProxyOrganizationId": "00498cc8500be9cxxxxxxx3aff766cac",
        "ProxyOrganizationOpenId": "d7c13a8b8134xxxx968c0ee248f04",
        "AppId": "65fb0c59104xxxxa382cc5ed0e"
    },
    "TemplateId": "yDxlkUyKxxxxxxxxxjEvToNRI2MuTr",
    "OperateType": "select"
}

输出示例​

{
    "Response": {
        "AppId": "16fd2f7d7axxxxxf8d501d57b5ec",
        "AuthTag": "all",
        "FailMessageList": [],
        "OperateResult": "all-success",
        "ProxyOrganizationOpenIds": [
            "子客企业1",
            "子客企业2"
        ],
        "TemplateId": "yDxlkUyKQDpMxxxxxoNRI2MuTr",
        "RequestId": "s16395xxxxx249716125"
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.StaffAlreadyVerify员工已实名。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.Db数据库错误。
InternalError.DbConnection数据库连接出错。
InternalError.DbRead数据库读取失败。
InternalError.DbUpdate数据库更新记录出错。
InternalError.Decryption解密错误。
InternalError.Encryption加密错误。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.EmptyParams参数为空。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
MissingParameter.Templates缺少模板参数。
OperationDenied操作被拒绝。
OperationDenied.AuthTag不支持的可见性标识。
OperationDenied.NoApiAuth没有API权限。
OperationDenied.OperateType操作类型不支持。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.ApplicationAuth应用授权记录未找到。
ResourceNotFound.Organization机构不存在。
ResourceNotFound.Template模板不存在。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。