跳到主要内容

批量操作企业初始化

1. 接口描述

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

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

此接口存在以下限制:

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

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateBatchInitOrganizationUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent应用相关信息。 此接口Agent.AppId 必填。
OperateTypes.NArray of String初始化操作类型
  • CREATE_SEAL : 创建印章
  • OPEN_AUTO_SIGN :开通企业自动签署
ProxyOrganizationOpenIds.NArray of String批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个

3. 输出参数

参数名称类型描述
MiniAppPathString小程序路径
OperateLongUrlString操作长链
OperateShortUrlString操作短链
QRCodeUrlString操作二维码
RequestIdString唯一请求 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. 错误码

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

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