创建粉丝群

收藏
我的收藏
该接口用于以群主身份创建粉丝群​

接口说明​

注意事项​

    由于外部头像url存在安全风险,开发者在调用建群接口前需通过图片上传工具拿到image_Id 传入到入参 avatar_uri。抖音开放平台目前支持创建万粉群、主播粉丝群,群类型通过接口入参的group_type字段进行区分​
群类型​
数据类型​
枚举值​
建群条件​
主播粉丝群​
int​
2​
    需要用户通过实名认证​
    需要用户有开播纪录​
万粉群​
int​
5​
    需要用户粉丝量过万​
    粉丝群等级权益与条件如下图所示:​
粉丝群等级等级权益​
开通条件​
Lv.1 可创建10个粉丝群​
粉丝数量>1w​
Lv.2 可创建20个粉丝群​
以下条件满足其一:​
    粉丝数量>10w​
    月日均gmv>=2000​
    累计群人数>2000且近7天累计群发言人数>20人​
Lv.3 可创建40个粉丝群​
以下条件满足其一:​
    粉丝数量>100w​
    月日均gmv>=10000​
    累计群人数>4000且近7天累计群发言人数>30人​
Lv.4 可创建100个粉丝群​
以下条件满足其一:​
    群人数>10000​
    近7天累计群发言人数>100人​
    群主发消息条数>20条​

接口信息​

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

请求头​

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

请求参数

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

请求 Body​

字段
数据类型
必填
说明
open_id​
string​
是​
群主openid​
group_name​
string​
是​
群名称​
avatar_uri​
string​
是​
群头像(avatar_uri字段需根据图片上传工具imageUpload获取)链接: 图片上传工具
group_type​
int​
否​
不传默认创建万粉群,2对应主播粉丝群;5对应万粉群​
description​
string​
否​
群简介,不超过30个中文字符​
open_audit_switch​
int​
否​
1 开启进群审批 ​
0 不开启​
show_at_profile​
int​
否​
1 展示到个人主页 其他 不展示(主播粉丝群默认不在个人主页展示加群入口)​
live_auto_sync​
int​
否​
1 直播同步 其他 不同步​
item_auto_sync​
int​
否​
1 作品同步 其他 不同步​

返回值

字段
数据类型
说明
group_id​
string​
粉丝群 ID​
extra​
object​
请求错误信息​
data​
object​
请求错误信息​

示例

    请求​
Shell
复制
curl -X POST 'https://open.douyin.com/im/group/fans/create/?open_id=123-4567-890' \
-H 'Content-Type:application/json' \
-H 'access-token:act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ec' \
--data '{
"avatar_uri":"https://xxx",
"group_name":"创建群",
"description":"创建群",
"open_audit_switch":1,
"show_at_profile":1,
"live_auto_sync":1,
"item_auto_sync":1
}'
    正常返回​
JSON
复制
{
"extra": {
"description": "",
"sub_error_code": 0,
"sub_description": "",
"now": 1648797449,
"logid": "021648797449846fd1b1111000700600000000000000086dfb920",
"error_code": 0
},
"data": {
"error_code": 0,
"description": ""
},
"group_id": "aaaaaaa"
}

错误码​

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