接口说明

直播挂载小玩法后，开发者可以批量查询用户粉丝团信息。调用获取用户粉丝团信息接口的条件：

• 已开通“直播间粉丝团互动数据能力”，能力开通申请可前往开放平台-能力-基础互动能力进行申请开通

• 查询粉丝粉丝团数量不能超过10个，且必须开启了粉丝团推送任务

使用限制

频率限制：单个 app_id 调用上限为 10 次/秒。

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/live_data/fans_club/get_info
HTTP Method	GET
Scope	live_data_push

请求参数

请求头

access-token必填String

示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d

调用https://developer.toutiao.com/api/apps/v2/token生成的token

content-type必填String

示例：application/json

固定值"application/json"

Query

anchor_openid必填String

主播OpenID

roomid必填Int64

直播间ID

user_openids必填Array<String>

需要获取粉丝团信息的用户openID集合，单次最多获取10个用户的信息 (openid之间逗号分隔)

请求示例
curl --location 'https://webcast.bytedance.com/api/live_data/fans_club/get_info?roomid=7238876224917949240&anchor_openid=anchorOpenID&user_openids=user_a,user_b' \
--header 'access-token: 08011218463250582b503255787863733134566c7153426d32773d3d' \
--header 'Content-Type: application/json' \

响应参数

Body展开全部子属性

err_msg必填String

非0错误码时，携带额外的错误提示信息

err_no必填Int32

请求错误码，0表示成功，非0表示失败

logid必填String

问题排查用日志ID

dataStruct

每个用户的粉丝团数据，包括粉丝团等级分层、加团时间，若某个openID未加团，则该 openID对应返回空数据

展开子属性

响应示例
{
  "data": {
    "fans_club_Info": {
      "user_a": {
        "level_layer": 1,
        "participate_time": 1685432708
      },
      "user_b": {}
    }
  },
  "err_msg": "",
  "err_no": 0,
  "logid": "202305301607286362259A1CEFF06192D"
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	10001	内部错误，可以尝试重新请求	尝试重新请求
200	40022	无效的AccessToken	检查token是否错误/失效
200	10004	直播间未挂载玩法	确认已挂载直播间
200	5003019	当前直播间未启粉丝团推送任务动，无法查询粉丝团信息	确保启动了推送任务
200	4005014	必要参数未携带或为空	确保必填参数非空
200	4001015	业务校验错误	单次查询用户粉丝团数据超过10个主播openID与accessToken对应的玩法不匹配当前主播ID并非直播间开播主播

获取粉丝团信息在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

获取粉丝团信息