跳到主要内容

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

1. 接口描述​

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

此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。

使用场景

1：查询 OperateType=SELECT

  • 查询第三方应用平台模板库的可见性以及授权的子客列表。

    2：修改部分子客授权 OperateType=UPDATE

  • 对子客企业进行模板库中模板可见性的进行修改操作。

  • 当模板未发布时，可以修改可见性AuthTag（part/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.AppId必填。
OperateType是String操作类型，
查询:"SELECT"，
删除:"DELETE"，
更新:"UPDATE"
TemplateId是String第三方应用平台模板库模板唯一标识
ProxyOrganizationOpenIds否String合作企业方第三方机构唯一标识数据.
支持多个， 用","进行分隔
AuthTag否String模板可见性,
全部可见-"all",
部分可见-"part"
Available否Integer当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
若此字段值为0，则不会修改模板Available，
1为启用模板，
2为停用模板。
启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。

3. 输出参数​

参数名称类型描述
AppIdString腾讯电子签颁发给第三方应用平台的应用ID
注意：此字段可能返回 null，表示取不到有效值。
TemplateIdString第三方应用平台模板库模板唯一标识
注意：此字段可能返回 null，表示取不到有效值。
OperateResultString描述模板可见性更改的结果，和参数中Available无关。
全部成功-"all-success",
部分成功-"part-success",
全部失败-"fail"，失败的会在FailMessageList中展示。
注意：此字段可能返回 null，表示取不到有效值。
示例值：all-success
AuthTagString模板可见性,
全部可见-"all",
部分可见-"part"
注意：此字段可能返回 null，表示取不到有效值。
示例值：SELECT
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": {
        "AppId": "yD*****id"
    },
    "TemplateId": "yDxlkUyKxxxxxxxxxjEvToNRI2MuTr",
    "OperateType": "select"
}

输出示例​

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

示例2 设置Available为启用​

设置Available为启用--成功

尽管OperateResult是fail，但是这只代表更改可见性失败了，对于Available的更改是成功的。

输入示例​

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

{
    "Agent": {
        "AppId": "yDwFoUUckpsomwx1Uyh********",
        "ProxyOrganizationOpenId": "*******anization_1",
        "ProxyOperator": {
            "OpenId": "*****heng",
            "Channel": "SBZEV*****"
        }
    },
    "OperateType": "update",
    "TemplateId": "yDwFiUUckpsz25w1UxjZYF********",
    "AuthTag": "all",
    "Available": 1
}

输出示例​

{
    "Response": {
        "AppId": "yDwFoUUckps*******hWGhIR2RkhOjw2",
        "AuthTag": "all",
        "FailMessageList": [
            {
                "Message": "已经是全部可见，勿重复操作",
                "ProxyOrganizationOpenId": ""
            }
        ],
        "OperateResult": "fail",
        "ProxyOrganizationOpenIds": [
            "first-organiz****",
            "****organization_1"
        ],
        "RequestId": "4031c******e-95f6-74b3225f279e",
        "TemplateId": "yDwFiUUckpsz25w1******"
    }
}

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操作不支持。