文档中心>API 中心

创建企业注销链接

最近更新时间:2024-10-30 01:35:41

我的收藏

1. 接口描述

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

创建企业注销链接

系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。

注意: 在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCloseOrganizationUrl。
Version String 公共参数,本接口取值:2021-05-26。
Region String 公共参数,此参数为可选参数。
Agent Agent 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

3. 输出参数

参数名称 类型 描述
ExpiredOn Integer 链接有效期,unix时间戳,精确到秒
示例值:1730257357
LongUrl String H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
示例值:https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88
ShortUrl String H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
示例值:https:/essurl.cn/ppiKUBJLt0
MiniAppPath String APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
示例值:pages/guide/index?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88
QrcodeUrl String 二维码链接
示例值:https://dyn.ess.tencent.cn/imgs/qrcode_urls/enterprise_logout_landing/yDCkxUUckp495fo9Ua9wie1hisAGTzhI.png
WeixinQrcodeUrl String 直接跳转至电子签小程序的二维码链接,无需通过中转页。您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。
示例值:https://res.ess.tencent.cn/mp-gate/release/ENTERPRISE_LOGOUT_LANDING?shortKey=yDCkuUW35EQA3r0aqr82
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建企业注销链接

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyOrganizationOpenId": "org_dianziqian",
        "AppId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    }
}

输出示例

{
    "Response": {
        "ExpiredOn": 1730257357,
        "LongUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88",
        "MiniAppPath": "pages/guide/index?to=ENTERPRISE_LOGOUT_LANDING&shortKey=yDCkuUW35EQA3r0aqr88",
        "QrcodeUrl": "https://dyn.ess.tencent.cn/imgs/qrcode_urls/enterprise_logout_landing/yDCkxUUckp495fo9Ua9wie1hisAGTzhI.png",
        "RequestId": "s1729652557401395967",
        "ShortUrl": "https://essurl.cn/ppiKUBJLt0",
        "WeixinQrcodeUrl": "https://res.ess.tencent.cn/mp-gate/develop/ENTERPRISE_LOGOUT_LANDING?shortKey=yDCkuUW35EQA3r0aqr88"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.Db 数据库错误。
InvalidParameter 参数错误。
InvalidParameter.ParamError 参数错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
ResourceUnavailable 资源不可用。
UnauthorizedOperation.NoPermissionFeature 请升级到对应版本后即可使用该接口。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。