wx/opensearchapi/nickname_group

获取用户分组与公众号对应关系

URL

http://${app_base}/api/wx/opensearchapi/nickname_group

请求方式

POST

访问授权限制

访问级别:普通接口
频次限制:

请求参数

参数名称 必选 类型及范围 说明
appid true string 此参数为API用户唯一标识,数值为平台分配的用户appid
appkey true string 此参数为API用户签名私钥,值为平台分配的用户appkey
groupid false int 平台内分组ID
start false int 搜索结果开始位置(默认为0,start=start+num 假定num=10 例:0,10;10,10;20,10;30,10...)
num false int 返回数据最大记录数(默认为20,最大不超过20)

返回结果

 JSON示例
  1. "returnCode" :"1001",
  2. "returnMsg" :"接口调用成功",
  3. "feeCount" :793,
  4. "returnData" :{
  5. "searchtime" :0.063957,
  6. "total" :1049,
  7. "num" :20,
  8. "viewtotal" :1049,
  9. "items" :[{
  10. "id" :"2806-294483",
  11. "group_id" :"2806",
  12. "nickname_id" :"294483",
  13. "uid" :"10000",
  14. "index_name" :"wx_group_nickname"
  15. }, {
  16. "id" :"6782-406507",
  17. "group_id" :"6782",
  18. "nickname_id" :"406507",
  19. "uid" :"10000",
  20. "index_name" :"wx_group_nickname"
  21. }],
  22. "facet" :[]
  23. }

关于错误返回值与错误代码,参见 错误代码说明

返回值字段 类型 说明
searchtime double 本次搜索耗时时间
total int 符合条件数据条数
num int 本次返回条数
viewtotal int 显示条数
id string 本记录在搜索引擎唯一主键,分组ID与公众号ID组合
group_id int 平台内分组ID
nickname_id int 平台内公众号ID
uid int 平台内用户ID
index_name string 搜索引擎名称

文档更新时间: 2016-01-07