创建企业批量认证链接-单链接

最近更新时间:2025-02-12 01:34:29

我的收藏

1. 接口描述

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

此接口用于获取企业批量认证链接-单链接包含多条认证流。

前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建子企业批量认证链接任务接口查询子企业批量认证链接DescribeBatchOrganizationRegistrationUrls 确保认证任务已经完成。

异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间。
此链接包含多条认证流程,使用该链接可以批量的对企业进行认证。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBatchOrganizationAuthorizationUrl。
Version String 公共参数,本接口取值:2021-05-26。
Region String 公共参数,此参数为可选参数。
Agent Agent 应用相关信息。 此接口Agent.AppId 必填。
AdminName String 组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。此参数需要跟创建子企业批量认证链接中 AdminName 保持一致。
示例值:典子谦
AdminMobile String 组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟创建子企业批量认证链接中 Admin Mobile保持一致。
示例值:13200000000
SubTaskIds.N Array of String 企业批量认证链接的子任务 SubTaskId,该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素(AdminName,AdminMobile,AdminIdCardNumber)配合使用。若 SubTaskId 不属于传入的超级管理员,将进行筛选。
示例值:["yDRS4UUgygqdcj56UuO4zjExBQcOiB68","yDRS4UUgygqdcj5pUuO4zjEu602GFIe6"]
AdminIdCardType String 组织机构超管证件类型支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
此参数需要跟创建子企业批量认证链接中 AdminIdCardType保持一致。
示例值:ID_CARD
AdminIdCardNumber String 组织机构超管证件号。 在注册流程中,必须是超管本人进行操作。此参数需要跟创建子企业批量认证链接中 AdminIdCardNumber保持一致。
示例值:620000198802020000
Endpoint String 要跳转的链接类型
  • HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)
  • HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
  • APP: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
  • QR_CODE: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型

示例值:HTTP

3. 输出参数

参数名称 类型 描述
AuthUrl 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,否则链接将被转义
示例值:https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCYwUBNmxArpbYpfCba
ErrorMessages Array of String 认证流认证失败信息
示例值:["企业信息错误"]
ExpireTime Integer 链接过期时间,为 7 天后,创建时间,格式为Unix标准时间戳(秒)。
示例值:1739241985
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据批量注册企业子任务 Id 和超管的三要素生成批量认证链接

根据批量注册企业子任务 Id 和超管的三要素生成批量认证链接。

  1. 批量注册企业子任务是由接口 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口 生成的。
  2. 调用查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls,获得子任务 TaskId。
  3. Endpoint 设置为长链接,会生成一条长链。

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "ceshi"
        },
        "ProxyOrganizationOpenId": "ceshi_org",
        "AppId": "60e16350b0361c888ecb30477d2c16e9"
    },
    "SubTaskIds": [
        "yDCHlUUckpaeefmfUxPr7deu6g5PvvJz",
        "yDCHlUUckpaeix9uU0ETNLSzHbAxJxLj"
    ],
    "AdminName": "典子谦",
    "AdminMobile": "13200000000",
    "AdminIdCardType": "ID_CARD",
    "AdminIdCardNumber": "620000198802020000",
    "Endpoint": "HTTP"
}

输出示例

{
    "Response": {
        "AuthUrl": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfCVEoeNYGCc6",
        "ErrorMessages": [],
        "ExpireTime": 1724165376,
        "RequestId": "s1723560576553977682"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NotAvailableSignReview 当前合同状态无法进行签署审批。
InternalError 内部错误。
InternalError.Db 数据库错误。
InvalidParameter 参数错误。
InvalidParameter.ParamError 参数错误。
InvalidParameter.Status 状态异常。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.NoFlowPermission 无权操作合同。
ResourceNotFound 资源不存在。
ResourceNotFound.Flow 未找到对应流程。
ResourceUnavailable 资源不可用。
UnauthorizedOperation.NoPermissionFeature 请升级到对应版本后即可使用该接口。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。