查询企业批量认证状态
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
本接口(DescribeBatchOrganizationRegistrationTasks)用于查询企业批量认证任务状态。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBatchOrganizationRegistrationTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
|
TaskIds.N | 否 | Array of String | 企业批量认证链接的子任务 SubTaskId,该 SubTaskId 是通过接口查询企业批量认证链接可以得到。 示例值:["yDRS4UUgygqdcj56UuO4zjExBQcOiB68","yDRS4UUgygqdcj5pUuO4zjEu602GFIe6"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Details | Array of BatchOrganizationRegistrationTasksDetails | 企业批量任务状态明细 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询批量企业认证任务状态
1.通过创建企业批量认证任务 创建了三个认证任务 2.其中一条认证流认证成功,一条认证流提交成功,一条认证流失败 3.返回具体的详细信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchOrganizationRegistrationTasks
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "dianziqian"
},
"ProxyOrganizationOpenId": "dianziqian_org",
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2"
},
"TaskIds": [
"yDt3sUUckpxe0hpyUuO0RjiSvVkhutfO",
"yDt3sUUckpxe0hpwUuO0RjiuHRkYOTjC",
"yDt3sUUckpxe0hpvUuO0Rji8Cg6fp80L"
]
}
输出示例
{
"Response": {
"Details": [
{
"ErrorMessage": "",
"Status": "Authorization",
"TaskId": "yDt3sUUckpxzouw8UuFrZIdSRJJWKucN"
},
{
"ErrorMessage": "",
"Status": "Submit",
"TaskId": "yDt3sUUckpxzouw8UuFrZIdSRJJWKucN"
},
{
"ErrorMessage": "认证失败,错误信息:此企业已经完成认证,请联系此企业的超级管理员(典*谦)加入该企业",
"Status": "Failed",
"TaskId": "yDt3sUUckpxzouw8UuFrZIdSRJJWKucN"
}
],
"RequestId": "s1750068263505524541"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.NoRoleAuth | 无角色授权,请确认数据是否存在 |
InternalError.DbRead | 数据库读取失败。 |
InvalidParameter.ParamError | 参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |