開發者可以使用接口,對公眾平台的分組進行查詢、創建、修改操作,也可以使用接口在需要時移動用戶到某個分組。
目錄[隱藏] |
創建分組
一個公眾賬號,最多支持創建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"}