腾讯电子签 撤销个人用户“授权签”的开通链接

接口请求域名: ess.tencentcloudapi.com 。用来撤销获取个人用户“授权签”的开通状态生成的开通链接,撤销生成的链接失效。

相关产品
腾讯电子签 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

注:

·若个人用户已经用生成的完成“授权签”的开通,撤销链接无效不会对开通结果产生影响(此情况接口会报错)。

·处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。

默认接口请求频率限制: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 : 通用场景示例值:E_PRESCRIPTION_AUTO_SIGN
UserInfo 是 UserThreeFactor 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
Agent 否 Agent 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

三、3. 输出参数

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

四、示例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": {
"Error": {
"Code": "FailedOperation.UserAutoSignEnableAlready",
"Message": "无法撤销,此用户已开通**签成功"
},
"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": {
"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"
}
}

十三、腾讯云 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: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十六、命令行工具

·Tencent Cloud CLI 3.0

十七、6. 错误码

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

错误码 描述
FailedOperation.UserAutoSignEnableAlready 无法撤销,用户已开通“授权签”。
FailedOperation.UserAutoSignEnableUrlNotExist 无法撤销,用户未生成开通链接。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
赞 (0)
上一篇 4天前
下一篇 4天前