跳到主要内容

第三方应用模板库管理

1. 接口描述​

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

此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。 平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置 image

支持的操作

1. 查询模板的子客企业授权 (OperateType=SELECT)​

  • 查询模板的授权子企业列表

2. 修改模板的子客企业授权 (OperateType=UPDATE)​

  • 当模板未发布时，可以修改模板的模板授权范围是所有第三方应用合作企业(AuthTag设置为all)或者指定第三方应用合作企业(AuthTag设置为part)，当模板发布后，不可做此修改
  • 如果模板是部分授权, 可通过ProxyOrganizationOpenIds增加子客的授权范围。

3. 取消模板的子客企业授权 (OperateType=DELETE)​

  • 对子客企业进行模板库中模板授权范围的进行删除操作。
  • 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
  • 对于自动领取的模板，由于已经下发，更改授权不会影响。
  • 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：OperateChannelTemplate。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId

OperateType是String操作类型，可取值如下:

  • SELECT: 查询
  • DELETE: 删除
  • UPDATE: 更新


示例值：SELECT
TemplateId是String合同模板ID，为32位字符串。
注: 此处为第三方应用平台模板库模板ID，非子客模板ID
示例值：yDSLZUUckpot5i01UydF1AEvOMQiKaBG
ProxyOrganizationOpenIds否String第三方平台子客企业的唯一标识，支持批量(用,分割)，
示例值：org_dianziqian,org_zhangsan
AuthTag否String模板可见范围, 可以设置的值如下:

all: 所有本第三方应用合作企业可见
part: 指定的本第三方应用合作企业

对应控制台的位置
image

示例值：part
Available否Integer当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。

  • 0: 不修改模板可用状态
  • 1: 启用模板
  • 2: 停用模板


启用后模板可以正常领取。

停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
如果Available更新失败，会直接返回错误。
示例值：1

3. 输出参数​

参数名称类型描述
AppIdString第三方应用平台的应用ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：yDwhxUUckp3gl8j5UuFX33LSNozpRsbi
TemplateIdString合同模板ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：yDwivUUckpo2g6ugUu4sxH2i15SY0OZY
OperateResultString描述模板可见性更改的结果。

  • all-success: 全部成功
  • part-success: 部分成功,失败的会在FailMessageList中展示
  • fail:全部失败, 失败的会在FailMessageList中展示


注意：此字段可能返回 null，表示取不到有效值。
示例值：all-success
AuthTagString模板可见范围:
all: 所有本第三方应用合作企业可见
part: 指定的本第三方应用合作企业
注意：此字段可能返回 null，表示取不到有效值。
示例值：all
ProxyOrganizationOpenIdsArray of String第三方平台子客企业标识列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：["org_zhangsan"]
FailMessageListArray of AuthFailMessage操作失败信息数组
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 删除部分授权子企业​

1.ProxyOrganizationOpenIds为要删除的子企业的标识列表

2.因为本模板是部分可见的AuthTag设置为part

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "OperateType": "DELETE",
    "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
    "ProxyOrganizationOpenIds": "org_zhangsan,org_lisi,org_wangwu",
    "AuthTag": "part"
}

输出示例​

{
    "Response": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
        "OperateResult": "all-success",
        "AuthTag": "part",
        "ProxyOrganizationOpenIds": [
            "org_dianziqian"
        ],
        "FailMessageList": [],
        "RequestId": "7ca39d89-2b6c-4fd9-9f32-735137d5a6e9"
    }
}

示例2 授权部分失败的情况​

因为org_fffffffffff不存在导致这个企业授权失败(其他的授权成功)

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "OperateType": "UPDATE",
    "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
    "ProxyOrganizationOpenIds": "org_zhangsan,org_lisi,org_fffffffffff",
    "AuthTag": "part"
}

输出示例​

{
    "Response": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
        "OperateResult": "part-success",
        "AuthTag": "part",
        "ProxyOrganizationOpenIds": [
            "org_zhangsan",
            "org_lisi",
            "org_dianziqian"
        ],
        "FailMessageList": [
            {
                "ProxyOrganizationOpenId": "org_fffffffffff",
                "Message": "非渠道合作企业openId"
            }
        ],
        "RequestId": "8b9e9a6b-2730-4971-8c4d-7c12d3905cd7"
    }
}

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

查询模板库中的模板信息

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "OperateType": "SELECT",
    "TemplateId": "yDSLZUUckpot5i01UydF1AEvOMQiKaBG",
    "ProxyOrganizationOpenIds": "",
    "AuthTag": ""
}

输出示例​

{
    "Response": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "TemplateId": "yDSLZUUckpot5i01UydF1AEvOMQiKaBG",
        "OperateResult": "all-success",
        "AuthTag": "all",
        "ProxyOrganizationOpenIds": [
            "org_lisi",
            "org_dianziqian",
            "org_zhangsan",
            "org_wangwu",
            "org_liubo"
        ],
        "FailMessageList": [],
        "RequestId": "75fffd24-3644-44eb-b7da-3849b942d69b"
    }
}

示例4 增加部分可见的模板授权子企业列表​

1.ProxyOrganizationOpenIds为新增的子企业的标识列表

2.因为本模板是部分可见的AuthTag设置为part

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "OperateType": "UPDATE",
    "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
    "ProxyOrganizationOpenIds": "org_zhangsan,org_lisi,org_wangwu",
    "AuthTag": "part"
}

输出示例​

{
    "Response": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY",
        "OperateResult": "all-success",
        "AuthTag": "part",
        "ProxyOrganizationOpenIds": [
            "org_dianziqian",
            "org_zhangsan",
            "org_lisi",
            "org_wangwu"
        ],
        "FailMessageList": [],
        "RequestId": "7ca39d89-2b6c-4fd9-9f32-735137d5a6e9"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.StaffAlreadyVerify员工已实名。
InternalError内部错误。
InternalError.Db数据库错误。
InternalError.DbConnection数据库连接出错。
InternalError.DbRead数据库读取失败。
InternalError.DbUpdate数据库更新记录出错。
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操作不支持。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062