# 获取可设置的所有类目

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getAllCategories

本接口可以获取该小程序允许设置的所有类目且仅支持获取一级类目和二级类目,注意不同主体所允许设置的类目不同。使用过程中如遇到问题,可在开放平台服务商专区发帖交流

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/cgi-bin/wxopen/getallcategories?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:30

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
categories_listobject类目信息列表

# Res.categories_list Object Payload

类目信息列表

参数名类型说明
categoriesobjarray类目信息

# Res.categories_list.categories(Array) Object Payload

类目信息

参数名类型说明
idnumber类目 ID
namestring类目名称
levelnumber类目层级
fathernumber类目父级 ID
childrennumarray子级类目 ID
sensitive_typenumber是否为敏感类目(1 为敏感类目,需要提供相应资质审核;0 为非敏感类目,无需审核)
qualifyobjectsensitive_type 为 1 的类目需要提供的资质证明,通过qualify.exter_list.inner_list.name可查看资质名称。

# Res.categories_list.categories(Array).qualify Object Payload

sensitive_type 为 1 的类目需要提供的资质证明,通过qualify.exter_list.inner_list.name可查看资质名称。

参数名类型说明
exter_listobjarray资质证明列表
remarkstring备注

# Res.categories_list.categories(Array).qualify.exter_listObject Payload

资质证明列表

参数名类型说明
inner_listobjarrayinner_list

# Res.categories_list.categories(Array).qualify.exter_list.inner_listObject Payload

inner_list

参数名类型说明
namestring资质文件名称
urlstring资质文件示例

# 4. 注意事项

# 其他说明

1、id == 0 的类目是根节点,它的 children 是一级类目

# 5. 代码示例

请求示例

GET https://api.weixin.qq.com/cgi-bin/wxopen/getallcategories?access_token=ACCESS_TOKEN

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "categories_list": {
    "categories": [
      {
        "id": 0,
        "children": [
          1,
          402
        ],
        "qualify": {
          "exter_list": [],
          "remark": ""
        }
      },
      {
        "id": 1,
        "name": "快递业与邮政",
        "level": 1,
        "father": 0,
        "children": [
          2,
          5,
          556,
          558,
          1033
        ],
        "sensitive_type": 0,
        "qualify": {
          "exter_list": [],
          "remark": ""
        }
      },
      {
        "id": 920,
        "name": "律师",
        "level": 2,
        "father": 402,
        "children": [],
        "sensitive_type": 1,
        "qualify": {
          "exter_list": [
            {
              "inner_list": [
                {
                  "name": "《律师执业资格证》",
                  "url": ""
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。