修改企业扩展服务
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyExtendedService。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId |
ServiceType | 是 | String | 扩展服务类型 AUTO_SIGN 企业静默签(自动签署) OVERSEA_SIGN 企业与港澳台居民*签署合同 MOBILE_CHECK_APPROVER 使用手机号验证签署方身份 PAGING_SEAL 骑缝章 DOWNLOAD_FLOW 授权渠道下载合同 |
Operate | 是 | String | 操作类型 OPEN:开通 CLOSE:关闭 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
OperateUrl | String | 操作跳转链接,有效期24小时 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接, 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": "PAGING_SEAL",
"Operate": "OPEN"
}
输出示例
{
"Response": {
"OperateUrl": "",
"RequestId": "s1673342239896659883"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |