# 查询API调用额度

调试工具

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

接口英文名:getApiQuota

本接口用于查询公众号/服务号/小程序/小游戏/微信小店/带货助手/视频号助手/联盟带货机构/移动应用/网站应用/多端应用/第三方平台等接口的每日调用接口的额度,调用次数,频率限制。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

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

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber返回码
errmsgstring错误信息
quotaobjectquota详情
rate_limitobject普通调用频率限制
component_rate_limitobject代调用频率限制

# Res.quota Object Payload

quota详情

参数名类型说明
daily_limitnumber当天该账号可调用该接口的次数
usednumber当天已经调用的次数
remainnumber当天剩余调用次数

# Res.rate_limit Object Payload

普通调用频率限制

参数名类型说明
call_countnumber周期内可调用数量,单位 次
refresh_secondnumber更新周期,单位 秒

# Res.component_rate_limit Object Payload

代调用频率限制

参数名类型说明
call_countnumber周期内可调用数量,单位 次
refresh_secondnumber更新周期,单位 秒

# 4. 注意事项

1、如果查询的api属于公众号的接口,则需要用公众号的 access_token;如果查询的api属于小程序的接口,则需要用小程序的access_token;如果查询的接口属于第三方平台的接口,则需要用第三方平台的component_access_token;如此类推。

2、如果查询的接口属于第三方平台接口但用于公众号/小程序,则需要用第三方平台的authorizer_access_token

2、如果是第三方服务商代公众号/服务号/小程序/微信小店/带货助手/视频号助手查询的接口,则需要用authorizer_access_token

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

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

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

# 5. 代码示例

请求示例

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

返回示例

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

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0okok
76021cgi_path not found, please checkcgi_path填错了
76022could not use this cgi_path,no permission当前调用接口使用的token与api所属账号不符,详情可看注意事项的说明

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序公众号服务号小游戏微信小店联盟带货机构带货助手第三方平台移动应用网站应用视频号助手多端应用