管理企业扩展服务

1. 接口描述

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

管理企业扩展服务

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

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

  • OPEN_SERVER_SIGN（企业自动签）

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyExtendedService。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 示例值：yDAVwUyKQWho8CUuO4zjEyQOAgwvr4Zy
ServiceType	是	String	要管理的拓展服务类型。 OPEN_SERVER_SIGN：企业自动签署 AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充 OVERSEA_SIGN：企业与港澳台居民签署合同 AGE_LIMIT_EXPANSION：拓宽签署方年龄限制 MOBILE_CHECK_APPROVER：个人签署方仅校验手机号 HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名 ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型 ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方 HIDE_ONE_KEY_SIGN：个人签署方手动签字 ORGANIZATION_FLOW_EMAIL_NOTIFY：邮件通知签署方 FLOW_APPROVAL：合同审批强制开启 ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导 示例值：MOBILE_CHECK_APPROVER
Operate	是	String	操作类型 OPEN : 开通 CLOSE : 关闭 示例值：OPEN
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
Endpoint	否	String	链接跳转类型，支持以下类型 WEIXINAPP : 短链直接跳转到电子签小程序 (默认值) APP : 第三方APP或小程序跳转电子签小程序 WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。 示例值：APP

3. 输出参数

参数名称	类型	描述
OperateUrl	String	操作跳转链接 有效期： 跳转链接的有效期为24小时。 无跳转链接返回的情况： 如果在操作过程中没有返回跳转链接，这意味着无需进行跳转操作。在这种情况下，服务将会直接被开通或关闭。 有跳转链接返回的情况： 当操作类型为“OPEN”（开通服务），并且扩展服务类型为以下之一时， 系统将返回一个操作链接。当前操作人（超级管理员或法人）需要点击此链接，以完成服务的开通操作。 OPEN_SERVER_SIGN（企业自动签署） 示例值：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: 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. 错误码

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

错误码	描述
FailedOperation	操作失败。
OperationDenied	操作被拒绝。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。