注意:
API 方法
公众号 API 支持以下方法:
接口名称 | 标识 | 描述 | 文档链接 |
清空 API 的调用 quota | clearQuota | 清空公众号调用接口的次数限制,使得公众号可以继续调用接口。 | |
查询 openAPI 调用 quota | getApiQuota | 查询公众号某个接口的调用次数限制。 | |
查询 rid 信息 | getRidInfo | 查询公众号的关联开放平台账号的身份识别信息。 | |
使用 AppSecret 重置 API 调用次数 | clearQuotaByAppSecret | 使用 AppSecret 重置公众号调用接口的次数限制。 | |
选用模板 | addTemplate | 选择使用公众号模板消息。 | |
删除模板 | deleteTemplate | 删除公众号已经添加的模板消息。 | |
获取公众号类目 | getCategory | 获取公众号可用的服务类目。 | |
获取模板中的关键词 | getPubTemplateKeyWordsById | 获取公众号模板消息中的关键词列表。 | |
获取类目下的公共模板 | getPubTemplateTitleList | 获取公众号指定服务类目下的公共模板消息列表。 | |
获取私有模板列表 | getTemplateList | 获取公众号已经添加的私有模板消息列表。 | |
发送订阅通知 | send | 发送订阅通知给用户。 | |
添加客服账号 | addAccount | 添加客服账号,用于处理用户的客服消息。 | |
修改客服账号 | modifyAccount | 修改客服账号的信息,例如昵称、头像等。 | |
删除客服账号 | deleteAccount | 删除客服账号,停止该账号接收用户的客服消息。 | |
设置客服账号的头像 | uploadHeadimg | 为客服账号设置头像,支持 jpg/png 格式,大小必须在100KB以下。 | |
获取所有客服账号 | getAccountList | 获取公众号所有的客服账号列表。 | |
客服接口-发消息 | sendMes | 客服向用户发送消息,包括文本、图片、语音、视频、音乐、图文等类型。 | |
客服输入状态 | inputType | 客服在输入状态时,向用户发送“正在输入”的提示。 | |
创建标签 | createTag | 创建用户标签,用于对用户进行分类管理。 | |
获取公众号已创建的标签 | getTag | 获取公众号已经创建的用户标签列表。 | |
编辑标签 | updateTag | 编辑已经创建的用户标签。 | |
删除标签 | deleteTag | 删除已经创建的用户标签。 | |
获取标签下的粉丝列表 | getTagAccountList | 获取某个用户标签下的粉丝列表。 | |
批量为用户打标签 | batchTagMembers | 给用户打上某个标签,支持批量操作。 | |
批量为用户取消标签 | cancelTagMembers | 给用户取消某个标签,支持批量操作。 | |
获取用户身上的标签列表 | getIdTags | 获取用户身上的标签列表。 | |
设置用户备注名 | setRemark | 给用户设置备注名,方便公众号进行用户管理。 | |
获取用户基本信息 | getUserInfo | 获取用户的基本信息,包括昵称、头像、性别等。 | |
批量获取用户基本信息 | getUserInfoList | 批量获取用户的基本信息,支持最多一次拉取100条。 | |
获取用户列表 | getUserList | 获取公众号的用户列表,支持分页获取。 | |
获取公众号的黑名单列表 | getBlackList | 获取公众号的黑名单列表,即被公众号拉黑的用户列表。 | |
拉黑用户 | batchBlackList | 将某个用户加入公众号的黑名单列表,拉黑后该用户将无法接收公众号的消息。 | |
取消拉黑用户 | cancelBlackList | 将某个用户从公众号的黑名单列表中移除,取消拉黑后该用户可以接收公众号的消息。 | |
获取用户增减数据 | getusersummary | 获取公众号关注者的增减数据,包括累计用户数、取消关注人数、净增用户数。 | |
获取累计用户数据 | getusercumulate | 获取公众号总用户数、新增用户数、取消关注人数的数据。 | |
获取图文群发每日数据 | getarticlesummary | 获取图文群发每日数据,包括群发次数、图文消息的送达情况、图文页的阅读次数、阅读人数、分享人数、分享次数等。 | |
获取图文群发总数据 | getarticletotal | 获取图文群发总数据,包括群发次数、图文消息的送达情况、图文页的阅读次数、阅读人数、分享人数、分享次数等。 | |
获取图文统计数据 | getuserread | 获取图文统计数据,包括图文页的阅读次数、阅读人数、分享人数、分享次数等。 | |
获取图文统计分时数据 | getuserreadhour | 获取图文统计分时数据,包括图文页的阅读次数、阅读人数、分享人数、分享次数等。 | |
获取图文分享转发数据 | getusershare | 获取图文分享转发数据,包括分享转发的场景、分享的次数、分享的人数、分享的人次等。 | |
获取图文分享转发分时数据 | getusersharehour | 获取图文分享转发分时数据,包括分享转发的场景、分享的次数、分享的人数、分享的人次等。 | |
获取消息发送概况数据 | getupstreammsg | 获取消息发送概况数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送分时数据 | getupstreammsghour | 获取消息发送分时数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送周数据 | getupstreammsgweek | 获取消息发送周数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送月数据 | getupstreammsgmonth | 获取消息发送月数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送分布数据 | getupstreammsgdist | 获取消息发送分布数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送分布周数据 | getupstreammsgdistweek | 获取消息发送分布周数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取消息发送分布月数据 | getupstreammsgdistmonth | 获取消息发送分布月数据,包括消息类型、发送量、送达量、打开量、即时消息回复量、即时消息回复率等。 | |
获取公众号分广告位数据 | publisher_adpos_general | 获取公众号分广告位数据,包括广告位 ID、广告位名称、曝光量、点击量、点击率等。 | |
获取公众号返佣商品数据 | publisher_cps_general | 获取公众号返佣商品数据,包括商品 ID、商品名称、曝光量、点击量、点击率、订单量、订单金额等。 | |
获取公众号结算收入数据及结算主体信息 | publisher_settlement | 获取公众号结算收入数据及结算主体信息,包括结算周期、结算收入、结算主体类型、结算主体名称、结算主体账号等。 | |
设置所属行业 | setIndustry | 设置公众号所属行业。 | |
获取设置的行业信息 | getIndustry | 获取公众号所属行业信息。 | |
获得模板 ID | getTemplate | 获得模板 ID。 | |
获得模板列表 | getTemplateList | 获得模板列表。 | |
删除列表 | delTemplate | 删除模板列表。 | |
发送模板消息 | sendTemplateMessage | 发送模板消息。 | |
获取 Access token | getAccessToken | 获取 Access token。 | |
获取 Stable Access token | getStableAccessToken | 获取 Stable Access token。 | |
获取 JS-SDK 配置信息 | getJSConfigInfo | 获取 JS-SDK 配置信息,包括 appId、timestamp、nonceStr、signature 等。 |