获取企业列表
概述
- 此 API 用于获取代理商下的企业列表；
授权方式
| 数据维度授权 | 代理商级授权 | 此 API 为代理商级授权，调用此 API 需要代理商级授权的授权账号。请参考 授权方式。 |
|---|
| 接口维度授权 | 默认授权 | 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
|---|
请求
请求域名
请求协议
| HTTP URL 路径 | /v1/corp/agency_corp_list |
|---|---|
| HTTP Method | GET |
请求 URL 参数
| 参数 | 类型 | 必填 | 参数说明 |
|---|---|---|---|
| ov_agencyid | string | 请参考参数说明 | 如果授权代理商是一级代理商则此参数必填 一级代理商 id |
| sub_agencyid | string | 请参考参数说明 | 如果授权代理商是二级代理商则此参数必填 二级代理商 id |
| ov_corpid | string | 否 | 企业 id。如果传递了此参数则只返回传对应的企业，多个企业 id 请使用英文逗号分隔。 |
| page | int | 否 | 分页参数。当前是第几页，从 1 开始，默认是 1。 |
| page_rows | int | 否 | 分页参数。每页多少条数据，默认是 2000。 |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/corp/agency_corp_list?ov_agencyid=test_ov_agencyid' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
响应
公共响应体
| 参数 | 类型 | 参数说明 |
|---|---|---|
| code | int | 错误代码。0 是成功，非 0 是失败，请参考 错误代码。 |
| msg | string | 错误描述，当失败的时候会给出具体的错误描述。 |
| req_id | string | 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。 |
| data | object | 业务数据 data 对象，详见下述 响应体 data 对象。 |
响应体 data 对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| total_count | string | 分页参数。一共有多少条数据。 |
| corp_list | array | 企业信息列表数据，此数组中的每个元素都是一个 corp 企业信息对象，请参考 corp - 企业信息对象。 |
corp - 企业信息对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| ov_corpid | string | 企业 id |
| corp_name | string | 企业名称 |
| create_time | string | 创建时间，整数时间戳，单位是秒。 |
| update_time | string | 最后修改时间，整数时间戳，单位是秒。 |
响应体示例
{ "code": 0, "msg": "", "data": { "total_count": "10", "corp_list": [ { "ov_corpid": "orion.ovs.entprise.12345678", "corp_name": "测试企业", "create_time": "1711966681", "update_time": "1711966681" }, // ... 省略其他 9 个企业信息对象 ] } }