获取商务中心列表
您可以使用本接口获取当前能够访问的商务中心列表。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/bc/get/| /v1.3/bc/get/|
|请求参数类型|bc_id: number|bc_id: string|
|返回参数名称和类型|id: number |bc_id: string |
|新增返回参数|/|verification_status`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/bc/get/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权access_token,可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
参数
|字段|类型|描述|
|---|---|---|
|bc_id |string| 商务中心ID。不传则默认返回用户所有的商务中心列表,传入时返回指定商务中心账户。 |
|page |number|当前页数,默认值: `1`,取值范围: ≥ 1。|
|page_size |number|分页大小,默认值: `10`,取值范围: 1-50。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/bc/get/?page=1&page_size=50' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|data |object|返回数据。 |
#|list |object[]| 商务中心列表。 |
##|bc_info |object| 商务中心。 |
###|bc_id |string| 商务中心ID。 |
###|verification_status|string|商务中心的企业验证状态。<br><br>枚举值:<ul><li>`NOT_SUBMITTED`:尚未提交资质证明。</li><li>`REVIEWING`:资质证明目前正在审核中。</li><li>`VERIFIED`:企业已成功通过验证。</li><li>`FAILED`:企业验证失败。</li><li>`EXPIRED`:企业验证已过期。</li></ul>|
###|name |string| 商务中心名称。 |
###|company |string| 商务中心公司名称。 |
###|currency |string| 商务中心支付币种,取值范围见[附录-币种](https://ads.tiktok.com/marketing_api/docs?id=1737585839634433) 。|
###|registered_area |string| 商务中心注册地代码。取值范围见[附录-地区代码](https://ads.tiktok.com/marketing_api/docs?id=1737585867307010)。 |
###|status |string| 商务中心状态,枚举值:`REVIEWING`(审核中),`DENY`(已拒绝),`ENABLE`(已通过),`PUNISH`(已禁用)。见 [枚举值-商务中心状态](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138) 。|
###|timezone |string| 商务中心所在时区,取值范围见[附录-时区信息](https://ads.tiktok.com/marketing_api/docs?id=1737586324313089)。 |
###|type |string| 商务中心类型。枚举值:<ul><li>`NORMAL`:普通商务中心。</li><li>`DIRECT`:非自助直客商务中心。</li><li>`AGENCY`:非自助代理商商务中心。</li><li>`SELF_SERVICE`:自助直客商务中心。</li><li>`SELF_SERVICE_AGENCY`:自助代理商商务中心。</li></ul> |
##|user_role |string| 商务中心用户角色。枚举值:`ADMIN`(管理员), `STANDARD`(标准成员) 。|
##|ext_user_role|object|用户在商务中心除基本角色外的扩展角色。|
###|finance_role|string|用户财务角色. 枚举: `MANAGER`(财务经理), `ANALYST`(财务分析师)。|
#|page_info |object| 分页信息。 |
##|page |number| 当前页数。 |
##|page_size |number| 分页大小。 |
##|total_number |number| 总结果数。 |
##|total_page |number| 总页数。 |
|request_id |string|请求的日志ID,唯一标识一个请求。 |
示例
(code Success-Response http)
{
"code": 0,
"message": "{{message}}",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"bc_info": {
"bc_id": "{{bc_id}}",
"company": "{{company}}",
"currency": "SGD",
"name": "{{name}}",
"organization_type": "STANDARD",
"registered_area": "SG",
"status": "ENABLE",
"timezone": "Asia/Jakarta",
"type": "SELF_SERVICE",
"verification_status": "NOT_SUBMITTED"
},
"ext_user_role": {
"finance_role": "MANAGER"
},
"user_role": "ADMIN"
}
],
"page_info": {
"page": 1,
"page_size": 50,
"total_number": 1,
"total_page": 1
},
"parent_bc": {
"bc_info": {}
}
}
}
(/code);