跳到主要内容

撤销自动签开通链接

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

此接口(ChannelCancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelCancelUserAutoSignEnableUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent渠道应用相关信息
OperatorUserInfo操作人信息
SceneKeyString自动签使用的场景值, 可以选择的场景值如下:
  • E_PRESCRIPTION_AUTO_SIGN : 电子处方场景
  • OTHER : 通用场景
UserInfoUserThreeFactor指定撤销链接的用户信息,包含姓名、证件类型、证件号码。

3. 输出参数

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

4. 示例

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

撤销自动签开通链接

输入示例

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

{
"Operator": {
"OpenId": "",
"ClientIp": "",
"CustomUserId": "",
"ProxyIp": "",
"Channel": ""
},
"SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
"Agent": {
"ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
"ProxyOperator": {
"OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
},
"AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
},
"UserInfo": {
"Name": "小明",
"IdCardNumber": "610000000000000000",
"IdCardType": "ID_CARD"
}
}

输出示例

{
"Response": {
"RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
}
}

5. 错误码

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

错误码描述
FailedOperation.UserAutoSignEnableAlready无法撤销,用户已开通自动签。
FailedOperation.UserAutoSignEnableUrlNotExist无法撤销,用户未生成开通链接。
InternalError.Db数据库错误。
InternalError.Encryption加密错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062