查询企业信息
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
查询渠道子客企业信息时，可以支持单个子客和整个应用下所有子客的查询。返回的信息包括超管、法人的信息以及当前企业的认证状态等信息。
- 对于单个企业的查询，通过指定子客的唯一标识来查询该子客的企业信息
- 对于整个应用下所有企业的查询，不需要指定子客的唯一标识，直接查询整个应用下所有子客企业的企业信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeChannelOrganizations。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证 |
| Limit | 是 | Integer | 指定分页每页返回的数据条数，单页最大支持 200。 示例值：100 |
| OrganizationOpenId | 否 | String | 该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。 注： 如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值 |
| AuthorizationStatusList.N | 否 | Array of String | 可以按照当前企业的认证状态进行过滤。可值如下：
|
| Offset | 否 | Integer | 指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ChannelOrganizationInfos | Array of ChannelOrganizationInfo | 满足查询条件的企业信息列表。 |
| Offset | Integer | 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。 |
| Limit | Integer | 指定分页每页返回的数据条数，单页最大支持 200。 |
| Total | Integer | 满足查询条件的企业总数量。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询单个企业的企业信息
查询单个企业的企业信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeChannelOrganizations
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"OrganizationOpenId": "org_dianziqian",
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"ChannelOrganizationInfos": [
{
"AdminMobile": "186****0000",
"AdminName": "典子谦",
"AdminOpenId": "n9527",
"AuthorizationStatus": "VERIFYING",
"AuthorizationType": "AuthorizationLegalPerson",
"LegalName": "典子谦",
"LegalOpenId": "n9527",
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"OrganizationName": "典子谦示例企业",
"OrganizationOpenId": "org_dianziqian",
"UnifiedSocialCreditCode": "X1440101304662708B"
}
],
"Limit": 20,
"Offset": 0,
"RequestId": "s1701931761617688110",
"Total": 1
}
}
示例2 批量查询应用下的所有企业信息
批量查询应用下的所有企业信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeChannelOrganizations
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"ChannelOrganizationInfos": [
{
"AdminMobile": "186****0000",
"AdminName": "典子谦",
"AdminOpenId": "n9527",
"AuthorizationStatus": "VERIFYING",
"AuthorizationType": "AuthorizationLegalPerson",
"LegalName": "典子谦",
"LegalOpenId": "n9527",
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"OrganizationName": "典子谦示例企业",
"OrganizationOpenId": "org_dianziqian",
"UnifiedSocialCreditCode": "X1440101304662708B"
},
{
"AdminMobile": "151****0000",
"AdminName": "李四",
"AdminOpenId": "org_lisi",
"AuthorizationStatus": "VERIFYING",
"AuthorizationType": "AuthorizationLegalPerson",
"LegalName": "张三",
"LegalOpenId": "n02468",
"OrganizationId": "yDwFqUUckpxxxxxxxxxxxxRvShTIZ3e",
"OrganizationName": "张三示例企业",
"OrganizationOpenId": "org_zhansan",
"UnifiedSocialCreditCode": "X1440106MA59B1269X"
}
],
"Limit": 20,
"Offset": 0,
"RequestId": "s1701931761617688110",
"Total": 2
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |