微信公众号API文档
本文档提供微信公众号开发所需的API接口详细说明,包括接口调用方式、参数说明、返回结果和示例代码。
API概述
微信公众号API主要分为以下几类:
- 基础接口:获取access_token、获取微信服务器IP等
- 消息管理:接收消息、发送消息、模板消息等
- 用户管理:用户标签、用户信息、用户分组等
- 素材管理:上传下载素材、获取素材列表等
- 自定义菜单:创建、查询、删除自定义菜单
- 账号管理:生成带参数二维码、短链接等
- 数据统计:用户分析、图文分析、消息分析等
- 微信支付:统一下单、查询订单、退款等(仅服务号)
- 微信卡券:创建卡券、管理卡券等(仅服务号)
调用规则
接口调用凭证
大部分API需要使用access_token
作为调用凭证,获取方式如下:
http
GET https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
返回结果:
json
{
"access_token": "ACCESS_TOKEN",
"expires_in": 7200
}
注意
- access_token有效期为7200秒(2小时)
- 请妥善保存AppSecret,避免泄露
- 请合理缓存access_token,避免频繁刷新
请求格式
- GET请求:参数直接拼接在URL中
- POST请求:参数以JSON格式提交,Content-Type为application/json
返回格式
所有接口均返回JSON格式数据,一般包含以下字段:
- 成功返回:包含业务数据
- 失败返回:包含errcode和errmsg
json
{
"errcode": 40001,
"errmsg": "invalid credential"
}
错误码
常见错误码及解决方案:
错误码 | 说明 | 解决方案 |
---|---|---|
-1 | 系统繁忙 | 稍后重试 |
0 | 请求成功 | - |
40001 | 获取access_token时AppSecret错误 | 检查AppSecret是否正确 |
40002 | 不合法的凭证类型 | 检查grant_type是否正确 |
40003 | 不合法的OpenID | 检查OpenID是否正确 |
40013 | 不合法的AppID | 检查AppID是否正确 |
40014 | 不合法的access_token | 重新获取access_token |
41001 | 缺少access_token参数 | 检查请求是否包含access_token |
42001 | access_token已过期 | 重新获取access_token |
45009 | 接口调用超过限制 | 减少接口调用频率 |
50001 | 用户未授权该接口 | 检查公众号是否有调用该接口的权限 |
接口列表
请查看以下分类了解详细API:
SDK与工具
为了简化开发,我们推荐使用以下SDK和工具:
- wechat-nodejs-sdk - Node.js SDK
- EasyWeChat - PHP SDK
- WeiXinMPSDK - .NET SDK
- weixin-java-tools - Java SDK
- 微信开发者工具 - 官方开发工具