开发者可以使用接口,对公众平台的分组进行查询、创建、修改操作,也可以使用接口在需要时移动用户到某个分组。
创建分组
一个公众账号,最多支持创建500个分组。 接口调用请求说明
http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/create?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:{"group":{"name":"test"}}
参数说明
参数 |
说明 |
access_token |
调用接口凭证 |
name |
分组名字(30个字符以内) |
返回说明 正常时的返回JSON数据包示例:
{
"group": {
"id": 107,
"name": "test"
}
}
参数说明
参数 |
说明 |
id |
分组id,由微信分配 |
name |
分组名字,UTF8编码 |
错误时的JSON数据包示例(该示例为AppID无效错误):
{"errcode":40013,"errmsg":"invalid appid"}
全局返回码说明
使用网页调试工具调试该接口
查询所有分组
接口调用请求说明
http请求方式: GET(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/get?access_token=ACCESS_TOKEN
参数说明
参数 |
说明 |
access_token |
调用接口凭证 |
返回说明 正常时的返回JSON数据包示例:
{
"groups": [
{
"id": 0,
"name": "未分组",
"count": 72596
},
{
"id": 1,
"name": "黑名单",
"count": 36
},
{
"id": 2,
"name": "星标组",
"count": 8
},
{
"id": 104,
"name": "华东媒",
"count": 4
},
{
"id": 106,
"name": "不测试组",
"count": 1
}
]
}
参数说明
参数 |
说明 |
groups |
公众平台分组信息列表 |
id |
分组id,由微信分配 |
name |
分组名字,UTF8编码 |
count |
分组内用户数量 |
错误时的JSON数据包示例(该示例为AppID无效错误):
{"errcode":40013,"errmsg":"invalid appid"}
全局返回码说明
使用网页调试工具调试该接口
查询用户所在分组
通过用户的OpenID查询其所在的GroupID。 接口调用请求说明
http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/getid?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:{"openid":"od8XIjsmk6QdVTETa9jLtGWA6KBc"}
参数说明
参数 |
说明 |
access_token |
调用接口凭证 |
openid |
用户的OpenID |
返回说明 正常时的返回JSON数据包示例:
{
"groupid": 102
}
参数说明
参数 |
说明 |
groupid |
用户所属的groupid |
错误时的JSON数据包示例(该示例为OpenID无效错误):
{"errcode":40003,"errmsg":"invalid openid"}
全局返回码说明
使用网页调试工具调试该接口
修改分组名
接口调用请求说明
http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:{"group":{"id":108,"name":"test2_modify2"}}
参数说明
参数 |
说明 |
access_token |
调用接口凭证 |
id |
分组id,由微信分配 |
name |
分组名字(30个字符以内) |
返回说明 正常时的返回JSON数据包示例:
{"errcode": 0, "errmsg": "ok"}
错误时的JSON数据包示例(该示例为AppID无效错误):
{"errcode":40013,"errmsg":"invalid appid"}
全局返回码说明
使用网页调试工具调试该接口
移动用户分组
接口调用请求说明
http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/cgi-bin/groups/members/update?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:{"openid":"oDF3iYx0ro3_7jD4HFRDfrjdCM58","to_groupid":108}
参数说明
参数 |
说明 |
access_token |
调用接口凭证 |
openid |
用户唯一标识符 |
to_groupid |
分组id |
返回说明 正常时的返回JSON数据包示例:
{"errcode": 0, "errmsg": "ok"}
错误时的JSON数据包示例(该示例为AppID无效错误):
{"errcode":40013,"errmsg":"invalid appid"}
全局返回码说明
使用网页调试工具调试该接口
网友评论