# Description
非微信应用获取微信公众号。
# Scene
当非微信应用需要使用到公众号时可以通过接口获取公众号的列表,并可以根据自己业务应用筛选拥有某个权限的公众号举例:微页面应用获取公众号,因为微页面应用需要用到公众号的网页授权等操作,因此需要根据authorizations来过滤筛选出应用需要的公众号。
# 接口路径
- version: 1.0.0
- https Request Methods: post
- url:
/v1/wc-official-account/query
,如:https://alpha-engage.gridsumdissector.com/open-api/wechat/v1/wc-official-account/query
# 请求参数
Name | Type | Description |
---|---|---|
profileId | String | 租户id |
userId | String | 用户Id |
data | Object | 业务数据 |
data.term | String | 名称模糊查询 |
data.offset | String | 起始位置 |
data.limit | String | 分页大小 |
data.sort | Array | 排序[["name","desc"]] |
data.status | String | 公众号状态(active:已启用、inactive:已停用、cancelAuthorized:取消授权) |
data.type | String | 类型:service、subscription |
data.verifyType | Integer | 认证类型-1:未认证 0:微信认证 |
data.ids | String[] | 公众号id数组 |
data.authorizations | Integer[] | 1.消息管理权限 、2.用户管理权限 、3.帐号服务权限 、4.网页服务权限 、5.微信小店权限 、6.微信多客服权限 、7.群发与通知权限 、8.微信卡券权限 、9.微信扫一扫权限 、10.微信连WIFI权限 、11.素材管理权限 、12.微信摇周边权限 、13.微信门店权限 、14.微信支付权限 、15.自定义菜单权限 、22.城市服务接口权限 、23.广告管理权限、 24.开放平台账号管理权限 、26.微信电子发票权限 |
如:
{
"profileId": "",
"userId": "",
"data": {
"term": "公众号1",
"offset": 0,
"limit": 10,
"sort": [],
"status": "active",
"type": "service",
"verifyType": "0",
"ids": ["id1","id2"], //非必传字段
"authorizations": [1, 2,] //非必传字段
}
}
# 响应参数
Name | Type | Description |
---|---|---|
errorCode | Integer | 错误码,0 表示成功调用,其他表示有错误。参考下面的错误码列表 |
errorMessage | String | 对用户友好的错误消息。当没有错误时,其值为空(空字符串,"") |
errorDetail | String | 面向开发人员的错误消息。当没有错误时,其值为空 |
errorLink | String | 错误相关的链接,如 FAQ、论坛页面等。当没有错误时,其值为空;有错误时也可以为空 |
traceId | String | 代表某个请求(用于日志跟踪定位)。该字段一般在测试环境有值,正式环境可能为空 |
data | Object | 返回的结果 |
data.total | String | 总记录数 |
data.rows.id | String | |
data.rows.name | String | 名称 |
data.rows.type | String | 公众号类型(subscription:订阅号、service:服务号) |
data.rows.verifyType | String | 认证状态: -1未认证、 0认证 |
data.rows.avatar | String | 头像 |
data.rows.status | String | 公众号状态(active:已启用、inactive:已停用、cancelAuthorized:取消授权) |
data.rows.qrCodeUrl | String | 公众号对应的二维码 |
data.rows.subType | String | 订阅号类型 media为媒体订阅号,其它为普通订阅号 |
data.rows.shortName | String | 公众号简称 |
data.rows.appId | String | 公众号appId |