查询群信息

收藏
我的收藏
该接口用于查询自身为群主的粉丝群信息。​
查询到群的 group_id 可用于 button组件加群能力

接口说明​

接口信息​

基本信息​
HTTP URL​
HTTP Method​
GET ​
Scope​
im.group_fans.create_list​
权限要求​
    小程序通过平台试运营期后默认获得的能力。注:关于小程序试运营期介绍详情请查看小程序试运营说明。​
    开发者后台-设置-关联设置-抖音号管理为小程序经营者申请粉丝群管理能力​

请求头​

字段
数据类型
必填
说明
access-token​
string​
是​
通过 BusinessToken 进行调用​
示例: bus_act.3c2f5cc363d5c464e509c066*********oDYf3Fmzl6ztOYr​
Content-Type​
string​
是​
固定值 application/json​

请求参数

    请求params​
字段
数据类型
必填
说明
open_id​
string​
是​
经营者唯一标识,可以通过:​
    通过控制台-能力-私信和群聊-群聊管理授权用户详情页中获取​
    其他OpenID获取方式获取​
示例:ba253642-0590-40bc-9bdf-9a1334b94059​

返回值

    JSON 数据包​
字段
数据类型
说明
group_list​
list​
查询 openid 为群主的创建的粉丝群​
extra​
object​
请求错误信息​
data​
object​
请求错误信息​
    group_list​
字段
数据类型
说明
exist_num​
int​
群现有人数​
group_name​
string​
群名称,最多支持12个字符​
max_num​
int​
群最大支持进入人数​
description​
string​
群简介,最多支持30个字符​
entry_limit​
list<string>​
群门槛,如无要求,万粉​
group_id​
string​
群组ID​
status​
string​
群状态 正常-"normal",封禁 -"ban",已满-"full"​
tags​
list<string>​
群标签,如活跃群,群主近期发言​
avatar_uri​
string​
群头像​

示例

    请求​
curl -X GET 'https://open.douyin.com/im/group/fans/list/?open_id=123-456-890'\ -H 'Content-Type:application/json' \ -H 'access-token:act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ec'
    返回​
{ "extra": { "description": "", "sub_error_code": 0, "sub_description": "", "now": 1648797449, "logid": "021648797449846fd1b1111000700600000000000000086dfb920", "error_code": 0 }, "data": { "error_code": 0, "description": "" }, "group_list": [ { "exist_num": 1, "group_name": "group_name", "max_num": 500, "description": "description", "entry_limit": null, "group_id": "@aaaaaa==", "status": "Normal", "tags": null, "avatar_uri": "avatar_uri" } ] }

错误码​

进入状态码排查工具进行排查。​