批量操作企业初始化
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
支持企业进行批量初始化操作:
此接口存在以下限制:
- 若批量操作中包含加入集团企业操作,则调用此接口的员工须有集团企业管理权限。
- 批量操作的企业需要已经完成电子签的认证流程。
- 通过此接口生成的链接在小程序端进行操作时,操作人需要是所有企业的超管或法人。
- 批量操作的企业,需要是通过平台方引导认证的企业。
- 操作链接过期时间默认为生成链接后7天。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBatchInitOrganizationUrl。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
OperateTypes.N | 是 | Array of String | 初始化操作类型
|
OrganizationIds.N | 是 | Array of String | 批量操作的企业Id列表,最大支持50个 |
Agent | 否 | Agent | 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MiniAppPath | String | 小程序路径 |
OperateLongUrl | String | 操作长链 |
OperateShortUrl | String | 操作短链 |
QRCodeUrl | String | 操作二维码 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建批量操作企业初始化链接
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchInitOrganizationUrl
<公共请求参数>
{
"Operator": {
"UserId": "yDxjOXXgydjfxgnzUuO4zjEWA07rD2xl"
},
"OperateTypes": [
"OPEN_AUTO_SIGN",
"AUTH_JOIN_ORGANIZATION_GROUP",
"CREATE_SEAL"
],
"OrganizationIds": [
"yDCpSUUckpao78exUIqrf58JQDTLbbTr",
"yDCpSUUckpao696tUIqrf5x1nPoxNy7C"
]
}
输出示例
{
"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 | 操作失败。 |
FailedOperation.AgeNotAchieveNormalLegal | 年龄限制无法使用电子签服务,请联系客服咨询处理。 |
FailedOperation.NotAvailableSignReview | 此合同流程不支持审批 |
FailedOperation.OrganizationExperienceChange | 企业经营状态与工商局信息不符。 |
FailedOperation.OrganizationNameChanged | 企业名称与工商局信息不符。 |
FailedOperation.OrganizationNameNeedChange | 企业名称与工商局信息不符,需要超管修改。 |
InternalError.Db | 数据库异常。 |
InternalError.DbRead | 内部错误,数据库查询失败,请稍后重试。 |
InternalError.Decryption | 解密失败。 |
InternalError.DependsApi | 依赖的第三方API返回错误。 |
InternalError.DependsDb | 数据库执行错误。 |
InternalError.Encryption | 加密失败。 |
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.ParamError | 参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoIdentityVerify | 未通过个人实名认证。 |
OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
OperationDenied.NoQuota | 企业额度不足,请检查企业额度后处理。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |