创建企业批量变更超管链接

最近更新时间:2025-11-21 01:23:20

我的收藏

1. 接口描述

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

此接口用于获取企业批量变更超管链接,包含多条超管变更任务。
一次性最多获取 500 条任务。

前提条件:已调用 CreateBatchAdminChangeInvitations生成批量变更超管任务接口 确保任务提交。
此链接包含多条超管变更流程,使用该链接可以批量的对企业进行超管变更。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBatchAdminChangeInvitationsUrl。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
Operator UserInfo 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
NewAdminName String 组织机构要变更的超管姓名。 在超管变更流程中,必须是超管本人进行操作,需要更当前操作人的姓名保持一致。

示例值:典子谦
NewAdminMobile String 组织机构要变更的超管手机号。
在超管变更流程中,必须是超管本人进行操作,需要更当前操作人的手机号保持一致。

超管手机号 和超管证件号 二选一 必填。

注意:
1. 如果新超管的个人身份在电子签进行了手机号的变更,之前提交的超管变更任务将无法获取。
示例值:1320***007
NewAdminIdCardType String 组织机构要变更的超管证件类型支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
需要更当前操作人的证件类型保持一致。

示例值:ID_CARD
NewAdminIdCardNumber String 组织机构要变更的超管证件号。
在超管变更流程中,必须是超管本人进行操作,需要更当前操作人的证件号保持一致。

超管手机号和超管证件号 二选一必填。
示例值:640521***113278
NotifyType String 通知方式。
NONE(默认)
SMS - 如果使用这个方式,则会给即将变更的超管发信息。
注意:
发送信息的手机号,是用户传递的手机号。
如果用户同时传递了证件号,手机号会被用户在电子签注册的手机号进行覆盖。
示例值:NONE
Endpoint String 要跳转的链接类型

  • HTTP:跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)。
  • HTTP_SHORT_URL:跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型,此时返回短链。
  • APP: 第三方APP或小程序跳转电子签小程序的path,APP或者小程序跳转适合此类型。
  • QR_CODE: 跳转电子签小程序的http_url的二维码形式,可以在页面展示适合此类型。


示例值:APP

3. 输出参数

参数名称 类型 描述
Url String 批量企业注册链接-单链接包含多条认证流,根据Endpoint的不同设置,返回不同的链接地址。失效时间:7天
跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表



Endpoint 示例 链接有效期限
HTTP https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa 7天
HTTP_SHORT_URL https://test.essurl.cn/8gDKUBAWK8 7天
APP pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde 7天
QR_CODE https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png 7天

注:
1.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义

示例值:pages/guide/index?to=BATCH_CHANGE_SUPER_ADMIN&shortKey=yDtzZUX5uY7W5lPn8P47
ExpireTime Integer 链接过期时间,为 7 天后,创建时间,格式为Unix标准时间戳(秒)。
示例值:1763963107
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成批量变更超管链接

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvypUEfH3DjwIpMfa0uw"
    },
    "NewAdminName": "典子谦",
    "NewAdminMobile": "1880***000",
    "NewAdminIdCardType": "ID_CARD",
    "NewAdminIdCardNumber": "640521***113278",
    "NotifyType": "NONE",
    "Endpoint": "APP"
}

输出示例

{
    "Response": {
        "ExpireTime": 1763963107,
        "Url": "pages/guide/index?to=BATCH_CHANGE_SUPER_ADMIN&shortKey=yDtzZUX5uY7W5lPn8P47",
        "RequestId": "e632a5a0-13aa-4ed1-afdc-5e5714a38fcd"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError.Db 数据库异常。
InternalError.System 系统错误,请稍后重试。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。