# 获取已设置的所有类目

调试诊断

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

接口英文名:getSettingCategories

使用本接口获取小程序已设置的所有类目。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/cgi-bin/wxopen/getcategory?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错误信息
categoriesobjarray已设置的类目信息列表
limitnumber一个更改周期内可以添加类目的次数
quotanumber本更改周期内还可以添加类目的次数
category_limitnumber最多可以设置的类目数量

# Res.categories(Array) Object Payload

已设置的类目信息列表

参数名类型说明
firstnumber一级类目 ID
first_namestring一级类目名称
secondnumber二级类目 ID
second_namestring二级类目名称
audit_statusnumber审核状态(1 审核中 2 审核不通过 3 审核通过)
audit_reasonstring审核不通过的原因

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

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

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "categories": [
    {
      "first": 8,
      "first_name": "教育",
      "second": 39,
      "second_name": "出国移民",
      "audit_status": 1,
      "audit_reason": ""
    }
  ],
  "limit": 5,
  "quota": 4,
  "category_limit": 20
}

# 6. 错误码

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

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试

# 7. 适用范围

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