# 查询API调用额度

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getApiQuota

本接口用于查询服务端接口的的每日调用接口的额度，调用次数，频率限制。

适用账号类型：公众号/服务号/小程序/小游戏/微信小店/带货助手/视频号助手/联盟带货机构/移动应用/网站应用/多端应用/第三方平台等接口

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/openapi/quota/get?access_token=ACCESS_TOKEN
```

> **支持加密请求：** 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。[查看详情](/miniprogram/dev/server/getting_started/api_signature.md)

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 自己调用，同时还支持代商家调用。

- 服务商获得任意权限集授权后，即可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](api_getaccesstoken)、[component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken.md)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "cgi_path",
    "类型": "string",
    "必填": "是",
    "说明": "api的请求地址，例如\"/cgi-bin/message/custom/send\";不要前缀“https://api.weixin.qq.com” ，也不要漏了\"/\",否则都会76003的报错"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "返回码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "quota",
    "类型": "object",
    "说明": "quota详情"
  },
  {
    "参数名": "rate_limit",
    "类型": "object",
    "说明": "普通调用频率限制"
  },
  {
    "参数名": "component_rate_limit",
    "类型": "object",
    "说明": "代调用频率限制"
  }
]
```

### Res.quota `Object Payload`

quota详情

```json
[
  {
    "参数名": "daily_limit",
    "类型": "number",
    "说明": "当天该账号可调用该接口的次数"
  },
  {
    "参数名": "used",
    "类型": "number",
    "说明": "当天已经调用的次数"
  },
  {
    "参数名": "remain",
    "类型": "number",
    "说明": "当天剩余调用次数"
  }
]
```

### Res.rate_limit `Object Payload`

普通调用频率限制

```json
[
  {
    "参数名": "call_count",
    "类型": "number",
    "说明": "周期内可调用数量，单位 次"
  },
  {
    "参数名": "refresh_second",
    "类型": "number",
    "说明": "更新周期，单位 秒"
  }
]
```

### Res.component_rate_limit `Object Payload`

代调用频率限制

```json
[
  {
    "参数名": "call_count",
    "类型": "number",
    "说明": "周期内可调用数量，单位 次"
  },
  {
    "参数名": "refresh_second",
    "类型": "number",
    "说明": "更新周期，单位 秒"
  }
]
```

## 4. 注意事项

1、如果查询的api属于公众号的接口，则需要用公众号的 access_token；如果查询的api属于小程序的接口，则需要用[小程序的access_token](api_getaccesstoken)；如果查询的接口属于第三方平台的接口，则需要用[第三方平台的component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken.md)；如此类推。

2、如果查询的接口属于第三方平台接口但用于公众号/小程序，则需要用第三方平台的[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)

2、如果是第三方服务商代公众号/服务号/小程序/微信小店/带货助手/视频号助手查询的接口，则需要用[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)

3、每个接口都有调用次数限制，请开发者合理调用接口。

4、”/xxx/sns/xxx“这类接口不支持使用该接口，会出现76022报错。

5、如果接口文档中有单独的说明接口的特殊的 quota 数量以及逻辑，则以每个接口的接口文档的描述为准。

## 5. 代码示例

请求示例

```json
{
  "cgi_path": "/wxa/gettemplatedraftlist"
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "quota": {
    "daily_limit": 0,
    "used": 0,
    "remain": 0
  }
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  },
  {
    "错误码": "76021",
    "错误描述": "cgi_path not found, please check",
    "解决方案": "cgi_path填错了"
  },
  {
    "错误码": "76022",
    "错误描述": "could not use this cgi_path，no permission",
    "解决方案": "当前调用接口使用的token与api所属账号不符，详情可看注意事项的说明"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "公众号": "✔",
    "服务号": "✔",
    "小游戏": "✔",
    "微信小店": "✔",
    "联盟带货机构": "✔",
    "带货助手": "✔",
    "小店供货商": "✔",
    "第三方平台": "〇",
    "移动应用": "✔",
    "网站应用": "✔",
    "视频号助手": "✔",
    "多端应用": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 〇：第三方平台可使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 调用，是否支持代商家调用需看本文档 调用方式 部分。