管理企业扩展服务
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
管理企业扩展服务
直接开通的情形： 若在操作过程中接口没有返回跳转链接，这表明无需进行任何跳转操作。此时，相应的企业拓展服务将会直接被开通或关闭。
需要法人或者超管签署开通协议的情形： 当需要开通以下企业拓展服务时， 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员（超管）或法人。由他们点击该链接，完成服务的开通操作。
- AUTO_SIGN（企业自动签）
- DOWNLOAD_FLOW（授权渠道下载合同）
注意： 在调用此接口以管理企业扩展服务时，操作者（ Agent.ProxyOperator.OpenId）必须是企业的超级管理员（超管）或法人
对应的扩展服务能力可以在控制台的【扩展服务】中找到
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyExtendedService。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经过实名认证 |
| ServiceType | 是 | String | 扩展服务类型
示例值：AUTO_SIGN |
| Operate | 是 | String | 操作类型
示例值：OPEN |
| Endpoint | 否 | String | 链接跳转类型，支持以下类型
示例值：APP |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OperateUrl | String | 操作跳转链接
示例值：https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 关闭自动签署
关闭企业静默签署扩展服务
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "AUTO_SIGN",
"Operate": "CLOSE"
}
输出示例
{
"Response": {
"OperateUrl": "",
"RequestId": "s1673342276656659884"
}
}
示例2 开通企业自动签署
开通企业自动签署扩展服务
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "AUTO_SIGN",
"Operate": "OPEN"
}
输出示例
{
"Response": {
"OperateUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
"RequestId": "s1673342132009427709"
}
}
示例3 修改不支持的特定扩展服务
传入了不支持的特定扩展服务，返回错误
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "TEST",
"Operate": "OPEN"
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.ParamError",
"Message": "参数错误。"
},
"RequestId": "s1**********72"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DbRead | 数据库读取失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |