批量清除未认证的企业认证流
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
批量清理未认证的企业认证流程。
此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。 为接口提交子企业批量认证链接创建任务 和查询子企业批量认证链接 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。
注意: 这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteOrganizationAuthorizations。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
|
AdminName | 否 | String | 认证人姓名,组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。 示例值:张三 |
AdminMobile | 否 | String | 认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。 示例值:18888888888 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DeleteOrganizationAuthorizationInfos | Array of DeleteOrganizationAuthorizationInfo | 清理认证流的详细信息,包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。 |
Status | Integer | 批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量清理张三的所有认证中的认证流
- 企业典子谦示例企业 通过生成批量认证接口生成了 两个认证企业 (张三示例企业一, 张三示例企业二)
- 此时操作人典子谦示例企业 的业务员典子谦 发现超管应该是李四,信息填写错误,希望批量清除之前写错的信息,进行重新认证。
- 此时传递超管的姓名和手机号, 来进行清理。
- 全部清理成功,status 返回为 1
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteOrganizationAuthorizations
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
}
},
"AdminName": "张三",
"AdminMobile": "18888888888"
}
输出示例
{
"Response": {
"DeleteOrganizationAuthorizationInfos": [
{
"AuthorizationId": "yDCkRUUckp4mdtwzUuvjSCCEzIZPsM4A",
"OrganizationName": "张三示例企业一",
"OrganizationOpenId": "org_zhangsan_1"
},
{
"AuthorizationId": "yDCkRUUckp4mdw8eUuYnzJiiRO2w2jQI",
"OrganizationName": "张三示例企业一",
"OrganizationOpenId": "org_zhangsan_2"
}
],
"RequestId": "37e81c99bc4e",
"Status": 1
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.NoRoleAuth | 无角色授权,请确认数据是否存在 |
InternalError.DbRead | 数据库读取失败。 |
InvalidParameter.ParamError | 参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |