跳到主要内容

查询企业批量认证链接

1. 接口描述

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

此接口用于获取企业批量认证异步任务的状态及结果。

前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。

异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:DescribeBatchOrganizationRegistrationUrls。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
TaskIdString通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id

3. 输出参数

参数名称类型描述
OrganizationAuthUrlsArray of OrganizationAuthUrl企业批量注册链接信息
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询批量企业认证

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "ceshi"
},
"ProxyOrganizationOpenId": "ceshi_org",
"AppId": "60e16350b0361c888ecb30477d2c16e9"
},
"TaskId": "yDSxSUUxxxxxxxx21JXBlJZsaj"
}

输出示例

{
"Response": {
"OrganizationAuthUrls": [
{
"AuthUrl": "https://test.qian.tencent.cn/console/batch-register?token=yDxxxxxxxxxgENliu9LD&orgName=典子谦批量认证企业",
"ErrorMessage": ""
}
],
"RequestId": "s1702447767875624775"
}
}

5. 错误码

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

错误码描述
InvalidParameter.ParamError参数错误。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062