文档中心>API 中心

批量操作企业初始化

最近更新时间:2025-01-13 19:32:27

我的收藏

1. 接口描述

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

支持企业进行批量初始化操作:

此接口存在以下限制:

  1. 批量操作的企业需要已经完成电子签的认证流程。
  2. 通过此接口生成的链接在小程序端进行操作时,操作人需要是所有企业的超管或法人
  3. 批量操作的企业,需要是本方第三方应用下的企业。
  4. 操作链接过期时间默认为生成链接后7天。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBatchInitOrganizationUrl。
Version String 公共参数,本接口取值:2021-05-26。
Region String 公共参数,此参数为可选参数。
Agent Agent 应用相关信息。 此接口Agent.AppId 必填。
OperateTypes.N Array of String 初始化操作类型

  • CREATE_SEAL : 创建印章
  • OPEN_AUTO_SIGN :开通企业自动签署
  • PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签


示例值:[OPEN_AUTO_SIGN, AUTH_JOIN_ORGANIZATION_GROUP, CREATE_SEAL]
ProxyOrganizationOpenIds.N Array of String 批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个
示例值:[tencent-testorg-cd, tencent-testorg-ca]
IsAuthorizePlatformApplication Boolean 当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
image
示例值:false
AuthorizedProxyOrganizationOpenId String 被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。



示例值:org_dianziqian

3. 输出参数

参数名称 类型 描述
MiniAppPath String 小程序路径,有效时间为7天
示例值:pages/guide/index?to=BATCH_INITIALIZATION_ORGANIZATIONS&shortKey=yDAHpURDf
OperateLongUrl String 操作长链,有效时间为7天
示例值:https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_INITIALIZATION_ORGANIZATIONS&shortKey=yDCHpURDfyLc5LgBhXb6
OperateShortUrl String 操作短链,有效时间为7天
示例值:https://essurl.cn/zahbUBHxW3
QRCodeUrl String 操作二维码,有效时间为7天
示例值:https://dyn.ess.tencent.cn/imgs/qrcode_urls/batch_initialization_organizations/yDCHHUUckpacc9ijUuXGmVcuzZCNH5pF.png
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建批量操作企业初始化链接

输入示例

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "",
        "AppId": "yDKHHUUckpacc9ijUuXGmVcuzACNH5pF"
    },
    "ProxyOrganizationOpenIds": [
        "tencent-testorg-cd",
        "tencent-testorg-ca",
        "tencent-testorg-zhangy",
        "tencent-testorg-tianjing",
        "tencent-testorg-hongkong"
    ],
    "OperateTypes": [
        "OPEN_AUTO_SIGN",
        "CREATE_SEAL"
    ]
}

输出示例

{
    "Response": {
        "MiniAppPath": "pages/guide/index?to=BATCH_INITIALIZATION_ORGANIZATIONS&shortKey=yDAHpURDfyLc5LgBhXb6",
        "OperateLongUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=BATCH_INITIALIZATION_ORGANIZATIONS&shortKey=yDCHpURDfyLc5LgBhXb6",
        "OperateShortUrl": "https://essurl.cn/zahbUBHxW3",
        "QRCodeUrl": "https://dyn.ess.tencent.cn/imgs/qrcode_urls/batch_initialization_organizations/yDCHHUUckpacc9ijUuXGmVcuzZCNH5pF.png",
        "RequestId": "s1723520103899037060"
    }
}

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 操作不支持。