创建粉丝群
收藏接口说明
创建万粉群和主播粉丝群
前提条件
调用接口前，openid对应的用户必须已提权授权im.group_fans.create_list这个scope，token使用授权后的access-token
使用限制
- 当前开放用户范围：认证企业号及其员工号和小程序品牌号及员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围
- 由于外部头像url存在安全风险，开发者在调用建群接口前需通过图片上传工具拿到image_id 传到该接口入参 avatar_uri中
- 创建万粉群需要用户粉丝量过万，创建主播粉丝群需要用户通过实名认证且有过开播记录
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/im/group/fans/create/ |
| HTTP Method | POST |
| Scope | im.group_fans.create_list |
| 权限要求 | 新能力上线能力实验室后，经营者可在“控制台-能力管理-能力实验室”中申请。后期能力若转为正式开放能力，可在“控制台-能力管理-互动权限”中申请. 小程序私信/群管理 满足任一能力即可 粉丝群管理 满足任一能力即可 |
请求参数
请求头
access-token必填String
示例：act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例：application/json
固定值"application/json"
Query
open_id必填String
示例：ba253642-0590-40bc-9bdf-9a1334b94059
调用/oauth/access_token/ 获取，用户唯一标识，必须跟access-token对应的openid对应
Body
avatar_uri必填String
示例：“https://”
群头像（avatar_uri字段需根据图片上传工具获取）链接：图片上传工具
description必填String
示例："粉丝群001简介"
群简介
group_name必填String
示例：“粉丝群001”
群名称
active_fansInt64
示例：1
进群门槛-粉丝活跃度 0-无要求 1-是群主的活跃粉丝
allow_inviteInt64
示例：1
允许群成员邀请朋友 1-允许 其他-不允许
fans_limitInt64
示例：1
进群门槛-粉丝团等级 0-无要求 1-1级及以上 3-3级及以上 5-5级及以上 9-9级及以上 12-12级及以上 15-15级及以上 17-17级及以上 20-20级及以上
group_typeInt64
示例：2
2 主播粉丝群 5 万粉群
item_auto_syncInt64
示例：1
1 作品同步 其他 不同步
live_auto_syncInt64
示例：1
1 直播同步 其他 不同步
open_audit_switchInt64
示例：1
1 开启进群审批 其他 不开启
relation_typeInt64
示例：1
进群门槛-关注条件 0-无要求 1-仅关注 7-关注我超过7天以上 30-关注我超过30天以上 60-关注我超过60天 以上
show_at_profileInt64
示例：1
1 展示到个人主页 其他 不展示
请求示例
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 }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extraStruct
展开子属性
group_idString
示例：“@jebkjeb87hbejfh==”
群组ID
响应示例
正常响应示例异常响应示例
{ "extra": { "description": "", "sub_error_code": 0, "sub_description": "", "now": 1648797449, "logid": "021648797449846fd1b1111000700600000000000000086dfb920", "error_code": 0 }, "data": { "error_code": 0, "description": "" }, "group_id": "@jebkjeb87hbejfh==" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100005 | 参数不合法 | 建议自查参数类型和取值是否符合规范 |
| 200 | 28001005 | 系统内部错误，请重试 | 请求重试，若依然无解请向平台提交反馈 |
| 200 | 28001003 | access_token无效 | 重新请求生成access_token |
| 200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
| 200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
| 200 | 28001006 | 网络调用错误，请重试 | 重试即可 |
| 200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
| 200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
| 200 | 28003017 | quota已用完 | 联系平台处理 |
| 200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁，联系平台处理 |
| 200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
