管理企业扩展服务

1. 接口描述

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

管理企业扩展服务

• 直接开通的情形： 若在操作过程中接口没有返回跳转链接，这表明无需进行任何跳转操作。此时，相应的企业拓展服务将会直接被开通或关闭。

• 需要法人或者超管签署开通协议的情形： 当需要开通以下企业拓展服务时， 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成服务的开通操作。

  • OPEN_SERVER_SIGN（企业自动签）

注意： 在调用此接口以管理企业扩展服务时，操作者（入参中的Operator）必须是企业的超级管理员（超管）或法人

对应的扩展服务能力可以在控制台的【扩展服务】中找到

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 关闭自动签署

输入示例

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

{
    "Operator": {
        "ClientIp": "8.8.8.8",
        "UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
    },
    "ServiceType": "OPEN_SERVER_SIGN",
    "Operate": "CLOSE",
    "Endpoint": "WEIXINAPP"
}

输出示例

{
    "Response": {
        "OperateUrl": "",
        "RequestId": "s1703747615889528031"
    }
}

示例2 开通自动签署

1.开通企业自动签署（ServiceType 设置为WEIXINAPP）
2.设置Endpoint 为WEIXINAPP ，得到小程序链接，操作人可拿链接签署协议开通自动签署

输入示例

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

{
    "Operator": {
        "ClientIp": "8.8.8.8",
        "UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
    },
    "ServiceType": "OPEN_SERVER_SIGN",
    "Operate": "OPEN",
    "Endpoint": "WEIXINAPP"
}

输出示例

{
    "Response": {
        "OperateUrl": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=yAABVUUckpt7e9gdUEcsWM19s3pglRL2&organizationId=yDxjOUUgydjf7zv3ACO4zjEC0AKihrfi&channelType=TENCENTCLOUD&expired_time=1703834015&login=1&verify=1",
        "RequestId": "s1703747615889528031"
    }
}

示例3 管理不支持的扩展服务

输入示例

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

{
    "Operator": {
        "ClientIp": "8.8.8.8",
        "UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
    },
    "ServiceType": "OPEN_SERVER",
    "Operate": "CLOSE",
    "Endpoint": "WEIXINAPP"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter.ParamError",
            "Message": "非法的扩展服务类型OPEN_SERVER,请确认后重试"
        },
        "RequestId": "s1703747916297948958"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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