创建粉丝群
接口说明
创建万粉群和主播粉丝群
前提条件
调用接口前,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"
Query
open_id必填String
示例:ba253642-0590-40bc-9bdf-9a1334b94059
用户open_id,通过/oauth/access_token/获取,用户唯一标志
Body
avatar_uri必填String
群头像
group_name必填String
群名称
active_fansInt64
进 群门槛-粉丝活跃度
allow_inviteInt64
允许群成员邀请朋友
descriptionString
群简介
fans_limitInt64
进群门槛-粉丝团等级
group_typeInt64
2 主播粉丝群 5 万粉群
item_auto_syncInt64
1 作品同步 其他 不同步
live_auto_syncInt64
1 直播同步 其他 不同步
open_audit_switchInt64
1 开启进群审批 其他 不开启
relation_typeInt64
进群门槛-关注条件
show_at_profileInt64
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
群组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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
