撤销个人用户自动签的开通链接

1. 接口描述

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

用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。

注:

• 若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。
• 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CancelUserAutoSignEnableUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
SceneKey	是	String	自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景
UserInfo	是	UserThreeFactor	预撤销链接的用户信息，包含姓名、证件类型、证件号码等信息。
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 撤销自动签开通链接成功

撤销自动签开通链接成功

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "Name": "小明",
        "IdCardNumber": "610000000000000000",
        "IdCardType": "ID_CARD"
    }
}

输出示例

{
    "Response": {
        "RequestId": "a97c85196a3e"
    }
}

示例2 已开通完成自动签，撤销链接失败

已经开通自动签成功，无法撤销

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "Name": "小强",
        "IdCardNumber": "610000000000000000",
        "IdCardType": "ID_CARD"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.UserAutoSignEnableAlready",
            "Message": "无法撤销，此用户已开通自动签成功"
        },
        "RequestId": "a97c85196a3e"
    }
}

示例3 未生成自动签链接，撤销链接失败

还未生成开通自动签链接，无法撤销

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "Name": "小红",
        "IdCardNumber": "610000000000000000",
        "IdCardType": "ID_CARD"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.UserAutoSignEnableUrlNotExist",
            "Message": "无法撤销，未生成此用户开通自动签链接"
        },
        "RequestId": "a97c85196a3e"
    }
}

5. 错误码

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

错误码	描述
FailedOperation.UserAutoSignEnableAlready	无法撤销，用户已开通自动签。
FailedOperation.UserAutoSignEnableUrlNotExist	无法撤销，用户未生成开通链接。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。