v3/qqgroup/get_app_groupmembers

2013年8月14日前创建的“托管模式”应用,不管是否上线均可以直接调用本接口。
2013年8月14日及以后创建的“托管模式”应用,需要申请使用权限。请按照模版提交API接口权限申请(申请方式详见这里),以获取接口调用权限。
“非托管模式”应用不支持调用本接口。

目录

What's New?

2013年07月16日,新增输入参数“page”,用于分页拉取群成员,新增对应的返回参数“cur_page”和“total_page”。

1 功能说明

应用注册了官方QQ群,且该群与应用进行了绑定,则调用本接口可以获取到官方QQ群里面已经安装了此应用的群成员信息。

注:
本接口目前只支持QQ空间平台。

2 接口调用说明

2.1 URL

http://[IP或域名]/v3/qqgroup/get_app_groupmembers

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

2.2 格式

json,xml

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数

参数名称 是否必须 类型 描述
group_openid 必须 string 公会QQ群openid,即通过接口fusion2.dialog.manageQQGroup创建或绑定公会QQ群时获得groupopenid。
unionid 必须 unsigned int 跟group_openid绑定的游戏公会ID。
zoneid unsigned int 应用调用接口fusion2.dialog.manageQQGroup将公会ID与QQ群绑定时,传入参数“zoneid”的值。
page unsigned int 分页拉取群成员。传入的值表示拉取第几页群成员信息,必须传入大于等于1的整数。

每页最多展示50个群成员信息。
不传或为空,默认为1,即默认拉取第1页的群成员信息。

2.6 请求示例

GET请求包示例(这里仅为示例,不能直接拷贝,请根据应用的实际情况输入相应的参数值):

http://openapi.tencentyun.com/v3/qqgroup/get_app_groupmembers?
openid=0000000000000000000000002329FBEF&
openkey=4EC7BF056460699AA2CEAFEA3C5DDADC&
appid=100646885&
pf=qzone&
format=json&
userip=112.90.139.30&
group_openid=9BCCF286DF606DA427964ED7DBBA7A71&
unionid=2&
zoneid=3&
sig=kLv%2B%2BcJZll3dciOO8YfEusBEa4w%3D

2.7 返回参数说明

参数名称 描述
ret 返回码。详见:公共返回码说明#OpenAPI V3.0 返回码
msg 如果错误,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

count 当前页安装了应用的群成员个数。
total_count 群中安装了应用的群成员总数。
items 群中安装了应用的群成员信息列表。
openid 成员ID。
name 成员名称,有设置群名片即返回群名片,没有则返回昵称。
gender 成员性别,直接返回“男”或“女”。
portrait_1 大小为40*40的QQ头像。
portrait_2 大小为100*100的QQ头像。
cur_page 当前拉取的是第几页的群成员信息,与输入参数page一致。
total_page 当前群成员的总页数。

2.8 错误返回码说明

公共错误返回码:公共返回码说明#OpenAPI V3.0 返回码
本接口私有错误返回码:

错误码 含义说明
2001 参数错误,请开发者根据OpenAPI的参数列表进行自查。
2002 没有绑定记录,请检查传入的公会ID和分区ID是否正确。
2003 需要群成员才能查看群成员列表。
2004 验证群openid和appid、公会id、分区id的对应关系失败。
2005 只有应用官方群才允许拉取群成员。
2006 验证群openid和应用的对应关系失败。
2010 系统错误,请通过企业QQ联系技术支持,调查问题原因并获得解决方案。

2.9 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
"ret": 0,
"is_lost": 0,
"count": 2,
"total_count": 2,
"cur_page": 1,
"total_page": 1,
"items": [

       {
           "openid": "0000000000000000000000002329FBEF", 
           "name": "斯蒂芬", 
           "gender": "女", 
           "portrait_1": "http://q.qlogo.cn/qqapp/27036/0000000000000000000000002329FBEF/41", 
           "portrait_2": "http://q.qlogo.cn/qqapp/27036/0000000000000000000000002329FBEF/100" 
       },        
       {
           "openid": "0000000000000000000000001D810387", 
           "name": "我有群名片啦!", 
           "gender": "女", 
           "portrait_1": "http://q.qlogo.cn/qqapp/27036/0000000000000000000000001D810387/41", 
           "portrait_2": "http://q.qlogo.cn/qqapp/27036/0000000000000000000000001D810387/100" 
       }        
    ]

}

2.10 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret": 2003,
"msg": "需要群成员才能查看群成员列表。"
}

相关文档

创建或加入应用QQ群:fusion2.dialog.inviteToGroup
查询用户所加入的应用QQ群信息:v3/qqgroup/is_group_member

以上信息是否解决您的问题?

Copyright © 1998 - 2018 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部